Share via


IMethods::GetDescription Method

Returns the description of the specified method in the method set.

HRESULT GetDescription ( 
   long index,
   BSTR* description
);

Parameters

  • index
    [in] Specifies the index position of the method in the method set.

  • description
    [out] Returns a string containing the method description. This value can be NULL.

Return Value

If the method succeeds, it returns S_OK. If it fails, it returns an error code.

Remarks

The description can be taken from comments that appear before the method or from some other source. Since this description is shown below the IntelliSense Parameter Info ToolTip, the description can include information about the parameters for that particular method signature; however, each parameter can also have its own description (see the IMethods::GetParameterInfo Method). Ultimately, where a description comes from is language-specific.

See Also

Reference

IMethods Interface

IMethods::GetParameterInfo Method