Web API Reference | MapGuide Open Source

- Overview
- Modules
- Classes

CreateFeatureSource
DescribeSchema
DescribeSchema
DescribeSchemaAsXml
DescribeSchemaAsXml
DescribeWfsFeatureType
EnumerateDataStores
ExecuteSqlNonQuery
ExecuteSqlQuery
GetCapabilities
GetClassDefinition
GetClasses
GetConnectionPropertyValues
GetFeatureProviders
GetLockedFeatures
GetLongTransactions
GetSchemaMapping
GetSchemas
GetSpatialContexts
GetWfsFeature
SchemaToXml
SelectAggregate
SelectFeatures
SelectFeatures
SetLongTransaction
TestConnection
TestConnection
UpdateFeatures
XmlToSchema
virtual MgFeatureSchemaCollection* MgFeatureService::DescribeSchema | ( | MgResourceIdentifier * | resource,
|  | CREFSTRING | schemaName,
|  | MgStringCollection * | classNames |
| ) |  |  | `[pure virtual]`
Gets the definitions of one or more schemas contained in the feature source for particular classes. If the specified schema name or a class name does not exist, this method will throw an exception. See Feature Schema . .NET Syntax
`virtual MgFeatureSchemaCollection DescribeSchema(MgResourceIdentifier resource, string schemaName, MgStringCollection classNames);`
Java Syntax
`virtual MgFeatureSchemaCollection DescribeSchema(MgResourceIdentifier resource, String schemaName, MgStringCollection classNames);`
PHP Syntax
`virtual MgFeatureSchemaCollection DescribeSchema(MgResourceIdentifier resource, string schemaName, MgStringCollection classNames);`
  Parameters:
  | resource | (MgResourceIdentifier) A resource identifier for the feature source.
  | schemaName | (String/string) The name of the schema definition to retrieve. If this string is empty, execution of the command will describe requested classes using the qualified class name. If the class name is not qualified, the requested class from all schemas will be described.
  | classNames | (MgStringCollection) A collection of strings identifying the feature classes for which to retrieve schema information. If this collection is null or empty, 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.
  Returns: Returns the schema collection representing the schema containing the class collection for the specified classes. Exceptions:
  | MgFeatureServiceException |
  | MgInvalidArgumentException |
  | MgFdoException |
Note: Please refer to Overview section of this document or Fdo provider documents for details on connection properties, schema and classes.

Comments or suggestions? Send us feedback.