FDO API Reference Feature Data Objects
Main Page | Modules | Class Hierarchy | Alphabetical List | Class List | File List | Class Members | File Members

FdoIGetLockedObjects Class Reference

#include <IGetLockedObjects.h>

Inherits FdoICommand.

Inheritance diagram for FdoIGetLockedObjects:

[legend]
List of all members.

Detailed Description

The FdoIGetLockedObjects interface defines the GetLockedObjects command, which gets a list of all objects that are currently locked by a particular user.

Definition at line 33 of file IGetLockedObjects.h.


Public Member Functions

virtual FDO_API FdoILockedObjectReaderExecute ()=0
 Executes the GetLockedObjects command, returning an FdoILockedObjectReader.
virtual FDO_API FdoStringGetLockOwner ()=0
 Gets the name of the user whose locked objects you want to list.
virtual FDO_API void SetLockOwner (FdoString *value)=0
 Sets the name of the user whose locked objects you want to list.

Member Function Documentation

virtual FDO_API FdoILockedObjectReader* FdoIGetLockedObjects::Execute  )  [pure virtual]
 

Executes the GetLockedObjects command, returning an FdoILockedObjectReader.

Returns:
Returns a list of all of the objects currently locked by a particular user.i The list might be empty if the user does not have anything locked.

virtual FDO_API FdoString* FdoIGetLockedObjects::GetLockOwner  )  [pure virtual]
 

Gets the name of the user whose locked objects you want to list.

Returns:
Returns the name of the user

virtual FDO_API void FdoIGetLockedObjects::SetLockOwner FdoString value  )  [pure virtual]
 

Sets the name of the user whose locked objects you want to list.

Parameters:
value Input the name of the user
Returns:
Returns nothing

The documentation for this class was generated from the following file:
Comments or suggestions? Send us feedback.