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

FdoIReleaseLock Class Reference

#include <IReleaseLock.h>

Inherits FdoIFeatureCommand.

Inheritance diagram for FdoIReleaseLock:

[legend]
List of all members.

Detailed Description

The FdoIReleaseLock interface defines the ReleaseLock command, which releases locks from feature instances of a given class that match the specified criteria. Input to the release lock command includes the name of the class and filter criteria by which to identify the instances to be unlocked. The filter may be specified either as text or as an expression tree (most likely produced by a query builder). The ability to successfully execute the command might be restricted by the datastore security if the lock doesn’t belong to the user executing the command.

Definition at line 39 of file IReleaseLock.h.


Public Member Functions

virtual FDO_API FdoILockConflictReaderExecute ()=0
 Executes the release lock command, returning an FdoILockConflictReader.
virtual FDO_API FdoStringGetLockOwner ()=0
 Gets the name of the user who owns the lock to release.
virtual FDO_API void SetLockOwner (FdoString *value)=0
 Sets the name of the user who owns the lock to release.

Member Function Documentation

virtual FDO_API FdoILockConflictReader* FdoIReleaseLock::Execute  )  [pure virtual]
 

Executes the release lock command, returning an FdoILockConflictReader.

Returns:
Returns a list of feature instances whose lock is owned by someone else.

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

Gets the name of the user who owns the lock to release.

Returns:
Returns name of the lock owner. If the name was not set, it returns the name of the caller.

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

Sets the name of the user who owns the lock to release.

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.