com.esri.arcgis.system
Interface IUID

All Superinterfaces:
Serializable
All Known Implementing Classes:
UID

public interface IUID
extends Serializable

Provides access to members that work with globally unique identifier objects.

When To Use

Use the IUID interface to set the value of a UID object, set the subtype of the UID object, generate a new globally unique value, or compare two UID objects.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

See Also:
UID

Method Summary
 boolean compare(IUID otherID)
          Indicates if the two UID objects represent the same globally unique identifier.
 void generate()
          Creates a new globally unique value for the UID object.
 int getSubType()
          The subtype of the UID object.
 Object getValue()
          The value of the UID object.
 void setSubType(int subType)
          The subtype of the UID object.
 void setValue(Object guidAsString)
          The value of the UID object.
 

Method Detail

getValue

Object getValue()
                throws IOException,
                       AutomationException
The value of the UID object.

Remarks

The Value property is a string representing either the CLSID or ProgID of an interface or coclass.

COM interfaces and coclasses are identified by a globally unique identifier (GUID). The GUID for an interface is called an interface ID (IID). The GUID for a coclass is called class ID (CLSID). A ProgID is a text alias for a CLSID; the ProgID is a string composed of the project name and the class name of the coclass.

ArcGIS Desktop developers can find the CLSID, ProgID, and subtype of a built-in command, menu, or toolbar in ArcMap or ArcCatalog, in the following technical documents:

ArcGIS Developer Help for Desktop developers > General reference > Names and IDs > ArcMap commands

ArcGIS Developer Help for Desktop developers > Technical General reference > Names and IDs > ArcCatalog commands

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Returns:
A Variant
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setValue

void setValue(Object guidAsString)
              throws IOException,
                     AutomationException
The value of the UID object.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:
guidAsString - A Variant (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

generate

void generate()
              throws IOException,
                     AutomationException
Creates a new globally unique value for the UID object.

Description

Creates a new globally unique value (GUID) for the UID object. This is a 128-bit integer used for CLSIDs and interface identifiers.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getSubType

int getSubType()
               throws IOException,
                      AutomationException
The subtype of the UID object.

Description

Use the SubType property when working with classes that implement ICommandSubType that have multiple commands within a single class.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Returns:
The subType
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setSubType

void setSubType(int subType)
                throws IOException,
                       AutomationException
The subtype of the UID object.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:
subType - The subType (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

compare

boolean compare(IUID otherID)
                throws IOException,
                       AutomationException
Indicates if the two UID objects represent the same globally unique identifier.

Description

Returns a boolean indicating whether the specified UID object represents the same globally unique value (GUID) as this UID object.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:
otherID - A reference to a com.esri.arcgis.system.IUID (in)
Returns:
The bEqual
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.