ICrmMonitorClerks::Description method (comsvcs.h)

Retrieves the description of the CRM Compensator for the specified index.

Syntax

HRESULT Description(
  [in]  VARIANT   Index,
  [out] LPVARIANT pItem
);

Parameters

[in] Index

The index of the required CRM clerk as a numeric Variant, or the instance CLSID as a Variant string.

[out] pItem

The description string originally provided by ICrmLogControl::RegisterCompensator.

Return value

This method can return the following values.

Return code Description
S_OK
The method completed successfully.
E_POINTER
A NULL pointer was provided as an argument.
E_INVALIDARG
One of the arguments is incorrect.

Requirements

Requirement Value
Minimum supported client Windows 2000 Professional [desktop apps only]
Minimum supported server Windows 2000 Server [desktop apps only]
Target Platform Windows
Header comsvcs.h

See also

ICrmMonitorClerks