FDO API Reference Feature Data Objects

FdoIDescribeSchemaMapping Class Reference

#include <IDescribeSchemaMapping.h>

Inherits FdoICommand.

Inheritance diagram for FdoIDescribeSchemaMapping:

Inheritance graph
[legend]
List of all members.

Detailed Description

The FdoIDescribeSchemaMapping interface defines the DescribeSchemaMapping command, which describes the logical to physical schema mappings for feature schemas available from the connection. The DescribeSchemaMapping command can describe the mappings for a single schema or all schemas available from the connection. The Execute operation returns an FdoPhysicalSchemaMappingCollection object.

Definition at line 38 of file IDescribeSchemaMapping.h.


Public Member Functions

virtual FDO_API FdoPhysicalSchemaMappingCollection * Execute ()=0
 Executes the DescribeSchemaMapping command and returns a FdoPhysicalSchemaMappingCollection. If the specified schema name does not exist, the Execute method throws an exception.
virtual FDO_API FdoBoolean GetIncludeDefaults ()=0
 Gets the current "include default mappings" setting.
virtual FDO_API FdoString * GetSchemaName ()=0
 Gets the name of the schema for which to describe schema mappings.
virtual FDO_API void SetIncludeDefaults (FdoBoolean includeDefaults)=0
 Sets the "include default mappings" setting.
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 the mappings for all schemas.

Friends

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