ICreateTypeInfo::SetFuncDocString method (oaidl.h)

  • Article

Sets the documentation string for the function with the specified index.

Syntax

HRESULT SetFuncDocString(
  [in] UINT     index,
  [in] LPOLESTR szDocString
);

Parameters

[in] index

The index of the function.

[in] szDocString

The documentation string.

Return value

This method can return one of these values.

Return code Description
S_OK
Success.
E_INVALIDARG
One or more of the arguments is not valid.
E_OUTOFMEMORY
Insufficient memory to complete the operation.
E_ACCESSDENIED
 Cannot write to the destination.
STG_E_INSUFFICIENTMEMORY
Insufficient memory to complete the operation.
TYPE_E_ELEMENTNOTFOUND
 The element cannot be found.

Remarks

The documentation string is a brief description of the function intended for use by tools such as type browsers. SetFuncDocString only needs to be used once for each property, because all property accessor functions are identified by one name.

Requirements

Requirement Value
Target Platform Windows
Header oaidl.h

See also

ICreateTypeInfo