FDO API Reference

Feature Data Objects

FdoClassCapabilities Class Reference

#include <ClassCapabilities.h>

Inherits FdoIDisposable.

Inheritance diagram for FdoClassCapabilities:

[legend]List of all members.

---

Detailed Description

The FdoClassCapabilites class describes various capabilities for a particular FDO Class Definition and an FDO Provider datastore.

Definition at line 34 of file ClassCapabilities.h.

Public Member Functions
FDO_API FdoLockType *	GetLockTypes (FdoInt32 &size)
	Gets an array of the FdoLockType values supported by the feature provider.
FDO_API FdoClassDefinition *	GetParent ()
	Gets the parent of this Class Capabilites object.
FDO_API void	SetLockTypes (const FdoLockType *types, FdoInt32 size)
	Sets the locking types support capability. This function should only be called from an FDO Provider.
FDO_API void	SetSupportsLocking (FdoBoolean value)
	Sets the locking support capability.
FDO_API void	SetSupportsLongTransactions (FdoBoolean value)
	Sets the long transaction support capability.
FDO_API void	SetSupportsWrite (FdoBoolean value)
	Sets the flag indicating whether or not write is supported. This function should only be called from an FDO Provider.
FDO_API FdoBoolean	SupportsLocking ()
	Gets the locking support capability.
FDO_API FdoBoolean	SupportsLongTransactions ()
	Gets the long transaction support capability.
FDO_API FdoBoolean	SupportsWrite ()
	Returns true if the class supports write.
Static Public Member Functions
FDO_API FdoClassCapabilities *	Create (FdoClassDefinition &parent)
	Constructs an FdoClassCapabilities instance. This function should only be called from an FDO Provider.
Protected Member Functions
virtual void	Dispose ()
	Dispose this object.
	FdoClassCapabilities (FdoClassDefinition &parent)
	FdoClassCapabilities ()
	DOXYGEN-IGNORE
virtual	~FdoClassCapabilities ()

---

Constructor & Destructor Documentation

FdoClassCapabilities::FdoClassCapabilities (   )  [protected]

DOXYGEN-IGNORE

FdoClassCapabilities::FdoClassCapabilities (  FdoClassDefinition &  parent  )  [protected]

virtual FdoClassCapabilities::~FdoClassCapabilities (   )  [protected, virtual]

---

Member Function Documentation

FDO_API FdoClassCapabilities* FdoClassCapabilities::Create (  FdoClassDefinition &  parent  )  [static]

Constructs an FdoClassCapabilities instance. This function should only be called from an FDO Provider. Parameters: parent  Input The Fdo Class Definition that owns these capabilities. Returns: Returns FdoClassCapabilities

virtual void FdoClassCapabilities::Dispose (   )  [protected, virtual]

Dispose this object. Returns: Returns nothing Implements FdoIDisposable.

FDO_API FdoLockType* FdoClassCapabilities::GetLockTypes (  FdoInt32 &  size  )

Gets an array of the FdoLockType values supported by the feature provider. Parameters: size  Output the number of lock types Returns: Returns the list of lock types

FDO_API FdoClassDefinition* FdoClassCapabilities::GetParent (   )

Gets the parent of this Class Capabilites object. Returns: Returns FdoClassDefinition

FDO_API void FdoClassCapabilities::SetLockTypes (  const FdoLockType *  types, FdoInt32  size )

Sets the locking types support capability. This function should only be called from an FDO Provider. Parameters: types  The supported array of lock types size  The number of lock types

FDO_API void FdoClassCapabilities::SetSupportsLocking (  FdoBoolean  value  )

Sets the locking support capability. Parameters: value  Input The locking support capability

FDO_API void FdoClassCapabilities::SetSupportsLongTransactions (  FdoBoolean  value  )

Sets the long transaction support capability. Parameters: value  Input The long transaction capability

FDO_API void FdoClassCapabilities::SetSupportsWrite (  FdoBoolean  value  )

Sets the flag indicating whether or not write is supported. This function should only be called from an FDO Provider. Parameters: value  Input The capability

FDO_API FdoBoolean FdoClassCapabilities::SupportsLocking (   )

Gets the locking support capability. Returns: Returns true if objects of this class can be locked

FDO_API FdoBoolean FdoClassCapabilities::SupportsLongTransactions (   )

Gets the long transaction support capability. Returns: Returns true if long transactions can be created on objects of this class

FDO_API FdoBoolean FdoClassCapabilities::SupportsWrite (   )

Returns true if the class supports write.

---

The documentation for this class was generated from the following file:

• ClassCapabilities.h

---

Comments or suggestions? Send us feedback.