FdoIDescribeSchema Class Reference

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. More...

#include <IDescribeSchema.h>

Inherits FdoICommand.

List of all members.


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
FdoStringCollection
GetClassNames ()=0
 Gets the names of the classes to retrieve. This is optional, if not specified execution of the command will describe all classes. If the class name is not qualified, and the schema name is not specified, the requested class from all schemas will be described. The class names specified serve only as a hint. Use of the hint during command execution is provider dependent. Providers that will not use the hint will describe the schema for all classes.
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 SetClassNames (FdoStringCollection *value)=0
 Sets the name of the classes to retrieve. This is optional, if not specified execution of the command will describe all classes. If the class name is not qualified, and the schema name is not specified, the requested class from all schemas will be described. The class names specified serve only as a hint. Use of the hint during command execution is provider dependent. Providers that will not use the hint will describe the schema for all classes.
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

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.


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