II3IDInitiatorObjectIDs::Add Method

Synopsis

Adds an ObjectID to the initiator object ID's list at the specified index position.  Items are appended to the list if the Index contains a value of -1.

IDL Function Prototype

HRESULT Add(

   [in] BSTR ID,

   [in] BSTR Label,

   [in, optional, defaultvalue(-1)] LONG Index,

   [out, retval] II3IDInitiatorObjectID ** InitiatorObject

);

C/C++ Syntax

HRESULT Add(BSTR ID, BSTR Label, LONG Index, II3IDInitiatorObjectID ** InitiatorObject);

Parameters

ID

This string should contain an Object ID.

Label

This string contains the label for this initiator object.

Index

This index number determines where the item is added to the collection.  Specify -1 to append the record to the end of the list.

InitiatorObject

The return value is an II3IDInitiatorObjectID initiator ID object.