Dela via


IDeclarations::GetDescription Method

Returns the quick info tip information shown when a user selects a language item in the completion list, such as a method name.

HRESULT GetDescription ( 
   long index,
   BSTR* description
);

Parameters

  • index
    [in] Index position of the item in the completion list.

  • description
    [out] Returns a string containing the description of the item to provide in the tip. 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 is displayed in a Quick Info tip next to an item in the completion list after the user selects the item, but before they have inserted it. For more information, see List Members in the MSDN Library.

The index parameter is typically the value returned from the IDeclarations::GetBestMatch Method.

See Also

Reference

IDeclarations Interface