This document is archived and information here might be outdated.  Recommended version.


IMapServer4.GetLegendInfo Method (ArcObjects .NET 10.6 SDK)
ArcObjects Library Reference (Carto)  

IMapServer4.GetLegendInfo Method

Returns a collection of Map Server Legend Info objects for the specified layers. If layerIDs is Nothing/Null or empty, legend information for all layers is returned.

[Visual Basic .NET]
Public Function GetLegendInfo ( _
    ByVal MapName As String, _
    ByVal layerIds As ILongArray, _
    ByVal patch As IMapServerLegendPatch, _
    ByVal imgType As IImageType _
) As IMapServerLegendInfos
[C#]
public IMapServerLegendInfos GetLegendInfo (
    string MapName,
    ILongArray layerIds,
    IMapServerLegendPatch patch,
    IImageType imgType
);
[C++]
HRESULT GetLegendInfo(
  BSTR MapName,
  ILongArray* layerIds,
  IMapServerLegendPatch* patch,
  IImageType* imgType
);
[C++]

Parameters MapName [in]
MapName is a parameter of type BSTR layerIds [in]
layerIds is a parameter of type ILongArray* patch [in]
patch is a parameter of type IMapServerLegendPatch* imgType [in]
imgType is a parameter of type IImageType*

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

See Also

IMapServer4 Interface