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


IComponentCategoryManager.Setup Method (ArcObjects .NET 10.6 SDK)
ArcObjects Library Reference (System)  

IComponentCategoryManager.Setup Method

Installs or uninstalls the objects that match the object type into the given category.

[Visual Basic .NET]
Public Sub Setup ( _
    ByVal pathname As String, _
    ByVal objectType As UID, _
    ByVal category As UID, _
    ByVal install As Boolean _
)
[C#]
public void Setup (
    string pathname,
    UID objectType,
    UID category,
    bool install
);
[C++]
HRESULT Setup(
  BSTR pathname,
  IUID* objectType,
  IUID* category,
  VARIANT_BOOL install
);
[C++]

Parameters pathname [in]
pathname is a parameter of type BSTR objectType [in]
objectType is a parameter of type IUID* category [in]
category is a parameter of type IUID* install [in]
install is a parameter of type bool

Product Availability

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

Description

PathName is a string representing the full path and filename of the DLL containing the objects you want to register/unregister in a category.

ObjectType is an IUID object representing the unique identifier of the type of object you want to register/unregister in a category. This UID would be the ID of an interface.

Category is an IUID object representing the unique identifier of the category in which you are registering/unregistering the objects.

install specifies whether you are registering (True) or unregistering (False) the objects.

Remarks

The Setup method provides a means of registering more than one object stored in a DLL. Setup will QueryInterface (QI) each object in the DLL for the interface specified by ObjectType. If the QI succeeds, it will add that object to the component category specified by Category

For example, you can have a single DLL that contains many commands (objects that implement ICommand). To register all the commands in this DLL with the commands category for ArcMap, you can set ObjectType to be the UID of the ICommand interface and set Category to be the UID of the ESRI Mx Commands category. You don't need to know the UID for each command. By calling Setup once, all the command objects in the DLL will be registered in this category.

If you use the SetupObject method instead, you would have to call SetupObject many times; once for each command in the DLL.

See Also

IComponentCategoryManager Interface