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

FdoIDescribeSchema Class Reference

#include <IDescribeSchema.h>

Inherits FdoICommand.

Inheritance diagram for FdoIDescribeSchema:

[legend]
List of all members.

Detailed Description

The FdoIDescribeSchema interface defines the DescribeSchema command, which describes the feature schemas available from the connection. The DescribeSchema command can describe a single schema or all schemas available from the connection. The Execute operation returns an FdoFeatureSchemaCollection object.

Definition at line 37 of file IDescribeSchema.h.


Public Member Functions

virtual FDO_API FdoFeatureSchemaCollectionExecute ()=0
 Executes the DescribeSchema command and returns a FdoFeatureSchemaCollection. If a schema name is given that has references to another schema, the dependent schemas will be returned as well. If the specified schema name does not exist, the Execute method throws an exception.
virtual FDO_API FdoStringGetSchemaName ()=0
 Gets the name of the schema to describe. This function is optional; if not specified, execution of the command will describe all schemas.
virtual FDO_API void SetSchemaName (FdoString *value)=0
 Sets the name of the schema to describe. This function is optional; if not specified execution of the command will describe all schemas.

Friends

class FdoIConnection

Member Function Documentation

virtual FDO_API FdoFeatureSchemaCollection* FdoIDescribeSchema::Execute  )  [pure virtual]
 

Executes the DescribeSchema command and returns a FdoFeatureSchemaCollection. If a schema name is given that has references to another schema, the dependent schemas will be returned as well. If the specified schema name does not exist, the Execute method throws an exception.

Returns:
Returns the schema collection representing the schema created. The element states for all elements will be set to FdoSchemaElementState_Unchanged. Each provider-specific implementation of Execute() can ensure that this is the case by calling FdoFeatureSchema::AcceptChanges() for each feature schema in the returned collection.

virtual FDO_API FdoString* FdoIDescribeSchema::GetSchemaName  )  [pure virtual]
 

Gets the name of the schema to describe. This function is optional; if not specified, execution of the command will describe all schemas.

Returns:
Returns the schema name

virtual FDO_API void FdoIDescribeSchema::SetSchemaName FdoString value  )  [pure virtual]
 

Sets the name of the schema to describe. This function is optional; if not specified execution of the command will describe all schemas.

Parameters:
value Input the schema name
Returns:
Returns nothing

Friends And Related Function Documentation

friend class FdoIConnection [friend]
 

Reimplemented from FdoICommand.

Definition at line 39 of file IDescribeSchema.h.


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