GetControlId method

The identifier of the control is returned in the specified variable.

Method

short GetControlId(

VARIANT * pControlID )

Parameters

pControlID: Points to a variable to receive the control ID. On return, this variable is set to type VT_I4.

Description

This control identifier can be used to reference information associated with a different Content Manager OnDemand OLE Control. See View multiple documents for a single folder) more information on control IDs.

Return Value

Refer to return codes.

Also see

OpenDoc method

C/C + +

The following examples retrieve the control ID.

 long ControlId;

   .
   .

 CArsOle  * pArsCtrl;
 VARIANT control_id;
 short rc;

   .
   .

  rc = pArsCtrl->GetControlId( &control_id );
  if ( rc != ARS_OLE_RC_SUCCESS )
    ERROR;

  ControlId = control_id.lVal;

   .
   .

Visual Basic

Dim rc As Integer
Dim control_id As Variant

 .
 .

rc = ArsOle.GetControlId (control_id)
If rc <> ARS_OLE_RC_SUCCESS Then
   MsgBox "ERROR"
   End
End If

 .
 .