Share via

IMethods::GetParameterInfo Method

  • Article

Returns the name, display information, and description of the specified parameter of the specified method.

HRESULT GetParameterInfo ( 
   long index,
   long parameter,
   BSTR* name,
   BSTR* display,
   BSTR* description
);

Parameters

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

  • parameter
    [in] Specifies the parameter. This is a zero-based index.

  • name
    [out] Returns a string containing the specified parameter name.

  • display
    [out] Returns a string with the complete parameter declaration, which is generally the type and name (for example, "BSTR* MyVariable"). This value cannot be NULL.

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

Return Value

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

Remarks

This method is called once for each parameter in a particular method signature. The number of times this method is called is determined by the number of parameters for the specified method as returned by the IMethods::GetParameterCount Method.

See Also

Reference

IMethods Interface