FDO API Reference Feature Data Objects

IGetLockInfo.h

Go to the documentation of this file.
00001 #ifndef _GETLOCKINFO_H_
00002 #define _GETLOCKINFO_H_
00003 // 
00004 
00005 //
00006 // Copyright (C) 2004-2006  Autodesk, Inc.
00007 // 
00008 // This library is free software; you can redistribute it and/or
00009 // modify it under the terms of version 2.1 of the GNU Lesser
00010 // General Public License as published by the Free Software Foundation.
00011 // 
00012 // This library is distributed in the hope that it will be useful,
00013 // but WITHOUT ANY WARRANTY; without even the implied warranty of
00014 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
00015 // Lesser General Public License for more details.
00016 // 
00017 // You should have received a copy of the GNU Lesser General Public
00018 // License along with this library; if not, write to the Free Software
00019 // Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
00020 //
00021 
00022 #ifdef _WIN32
00023 #pragma once
00024 #endif
00025 
00026 #include <FdoStd.h>
00027 #include <Fdo/Commands/IFeatureCommand.h>
00028 #include <Fdo/Connections/IConnection.h>
00029 #include <Fdo/Commands/Locking/ILockedObjectReader.h>
00030 
00031 /// \brief
00032 /// The FdoIGetLockInfo interface defines the GetLockInfo command, which gets a
00033 /// lock information for the feature instances of a given class that match the
00034 /// specified filter. If the filter is empty, all feature instances of the given class are selected.
00035 class FdoIGetLockInfo : public FdoIFeatureCommand
00036 {
00037     friend class FdoIConnection;
00038 
00039 public:
00040     /// \brief
00041     /// Executes the GetLockInfo command, returning an FdoILockedObjectReader.
00042     /// 
00043     /// \return
00044     /// Returns a locked object reader.
00045     /// 
00046     FDO_API virtual FdoILockedObjectReader* Execute() = 0;
00047 
00048 };
00049 #endif
00050 
00051 

Comments or suggestions? Send us feedback.