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


IMapServer4.GetLegendInfo2 Method (ArcObjects .NET 10.5 SDK)
ArcObjects Library Reference (Carto)  

IMapServer4.GetLegendInfo2 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 GetLegendInfo2 ( _
    ByVal pMapDescription As IMapDescription, _
    ByVal pImageDisplay As IImageDisplay, _
    ByVal layerIds As ILongArray, _
    ByVal patch As IMapServerLegendPatch, _
    ByVal imgType As IImageType _
) As IMapServerLegendInfos
[C#]
public IMapServerLegendInfos GetLegendInfo2 (
    IMapDescription pMapDescription,
    IImageDisplay pImageDisplay,
    ILongArray layerIds,
    IMapServerLegendPatch patch,
    IImageType imgType
);
[C++]
HRESULT GetLegendInfo2(
  IMapDescription* pMapDescription,
  IImageDisplay* pImageDisplay,
  ILongArray* layerIds,
  IMapServerLegendPatch* patch,
  IImageType* imgType,
  IMapServerLegendInfos** legendInfos
);
[C++]

Parameters pMapDescription [in]
pMapDescription is a parameter of type IMapDescription pImageDisplay [in]
pImageDisplay is a parameter of type IImageDisplay 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 legendInfos [out, retval]
legendInfos is a parameter of type IMapServerLegendInfos

Product Availability

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

See Also

IMapServer4 Interface