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

FdoIDescribeSchemaMapping Class Reference

#include <IDescribeSchemaMapping.h>

Inherits FdoICommand.

Inheritance diagram for FdoIDescribeSchemaMapping:

[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 FdoPhysicalSchemaMappingCollectionExecute ()=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 FdoStringGetSchemaName ()=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

Member Function Documentation

virtual FDO_API FdoPhysicalSchemaMappingCollection* FdoIDescribeSchemaMapping::Execute  )  [pure virtual]
 

Executes the DescribeSchemaMapping command and returns a FdoPhysicalSchemaMappingCollection. If the specified schema name does not exist, the Execute method throws an exception.

Returns:
Returns the schema mapping collection for the requested feature schemas.

virtual FDO_API FdoBoolean FdoIDescribeSchemaMapping::GetIncludeDefaults  )  [pure virtual]
 

Gets the current "include default mappings" setting.

Returns:
Returns True if Execute() will include default mappings.

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

Gets the name of the schema for which to describe schema mappings.

Returns:
Returns the schema name

virtual FDO_API void FdoIDescribeSchemaMapping::SetIncludeDefaults FdoBoolean  includeDefaults  )  [pure virtual]
 

Sets the "include default mappings" setting.

Parameters:
includeDefaults Input True: Execute() will return all mappings for the feature schema(s). False: Execute() will not include default logical to physical mappings, only those mappings that have been overridden will be returned.
Returns:
Returns nothing

virtual FDO_API void FdoIDescribeSchemaMapping::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 the mappings for 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 40 of file IDescribeSchemaMapping.h.


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