MapGuide API Reference
 All Classes Functions Variables Enumerations Enumerator Friends
virtual MgByteReader* MgMappingService::DescribeRuntimeMap ( MgMap map,
CREFSTRING  iconFormat,
INT32  iconWidth,
INT32  iconHeight,
INT32  requestedFeatures,
INT32  iconsPerScaleRange 
) [pure virtual]

Returns an XML-based description of the given runtime map.

.NET Syntax
virtual MgByteReader DescribeRuntimeMap(MgMap map, string iconFormat, int iconWidth, int iconHeight, int requestedFeatures, int iconsPerScaleRange);
Java Syntax
virtual MgByteReader DescribeRuntimeMap(MgMap map, String iconFormat, int iconWidth, int iconHeight, int requestedFeatures, int iconsPerScaleRange);
PHP Syntax
virtual MgByteReader DescribeRuntimeMap(MgMap map, string iconFormat, int iconWidth, int iconHeight, int requestedFeatures, int iconsPerScaleRange);
Parameters:
map(MgMap) The map to describe
iconFormat(String/string) The desired image format for icons (from MgImageFormats)
iconWidth(int) The width of each individual inline legend icons. Has no effect if icons was not requested in the response.
iconHeight(int) The height of each individual inline legend icons. Has no effect if icons was not requested in the response.
requestedFeatures(int) A bitmask representing the desired information to return in the XML response: 1=Layer/Group structure, 2=Layer Icons, 4=Layer Feature Source Information
iconsPerScaleRange(int) The number of legend icons per scale range to render inline in the XML response as base64 strings. If a scale range contains a number of rules that exceeds this value, only the first and last rules of a type style in the scale range will have inline icons
Remarks:
The bitmask values of 2 (Layer Icons) and 4 (Layer Feature Source Information) have no effect if 1 (Layer/Group structure) is not specified
Returns:
Returns an XML-based description of the runtime map
Exceptions:
MgInvalidArgumentException
MgNullArgumentException