II3IDInitiator2::InitiatorHandle Property

get_InitiatorHandle

This property returns the initiator handle for the initiator.

IDL Function Prototype

HRESULT InitiatorHandle(

   [out, retval] long * InitHdl

);

C/C++ Syntax

HRESULT get_InitiatorHandle(long * InitHdl);

Parameters

InitHdl

InitHdl will hold the initiator handle for the initiator. The initiator handle is not needed if you are using the Designer COM API but it is needed if you want to call initiator functions defined in the Designer C API - i3idtoolreg.h. Most initiator methods in the Designer C API require the caller to pass in a handle to identify the initiator. The example is an initiator method defined in the Designer C API. The handle returned from this property would be used for the I3IDInitHandle parameter.

C++ Example

IdToolRetCode_t REG_DLL I3IDSetInitRequiresLicenseComponent(
     I3IDInitHandle_t initHdl,
     const wchar_t * LicenseComponentName
);