FDO API Reference Feature Data Objects

FdoIDescribeSchema Class Reference

#include <IDescribeSchema.h>

Inherits FdoICommand.

Inheritance diagram for FdoIDescribeSchema:

Inheritance graph
[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 FdoFeatureSchemaCollection * Execute ()=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 FdoString * GetSchemaName ()=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
The documentation for this class was generated from the following file:
Comments or suggestions? Send us feedback.