Can I get a unique reference to a feature layer in ArcObjects?

Question

I want to build an IDictionary with the feature layers of my TOC in ArcObjects. So I need key value pairs. The value will be an attribute of the feature layer but I am wondering what to use as key. I can use the layer name but there can theoretically be duplicate layer names in the TOC. Any suggestions on how I can get a unique reference to a feature layer?

Background is that I need to store the layers and their querydefinitions in a custom application that runs in desktop and ArcEngine environment. I don't know the layers before. It could be that the user defines layer groups that have sublayers with the same name. This would lead to an error when storing it in the dictionary.

Answer 1

IEnumLayer will build an index for you when you initialize it. It indexes all layers in the order that they appear in the TOC (the top layer will be index 0, the next down will be 1, etc). You can use this index as your key as it will always be unique to the layer.

Here's the code to initialize and access in ArcGIS Desktop:

        ESRI.ArcGIS.ArcMapUI.IMxDocument pDoc;
        pDoc = ArcMap.Document;//get current mxd and set it as pDoc
        ESRI.ArcGIS.Carto.IActiveView activeView;
        activeView = pDoc.ActiveView;  

        IMap pMap = pDoc.FocusMap; //set pMap as current document


        ESRI.ArcGIS.Carto.IEnumLayer pEnumLayer;
        pEnumLayer = pDoc.FocusMap.Layers;  //get all layers in the map


        ESRI.ArcGIS.Carto.ILayer pLayer;
        pLayer = pEnumLayer.Next(); //grab the layer from enumerator

        while (pLayer != null) //loop through all your layers
        {
              //build your dictionary here
              pLayer = pEnumLayer.Next();
        }

If the user will get the chance to add, remove or reorder layers in the course of your application you will of course need to re-initialize IEnumLayers and rebuild your dictionary accordingly as necessary.