This method sets the documentation string for a function.
At a Glance
| Header file: | Oaidl.h |
| Windows CE versions: | 2.0 and later |
Syntax
HRESULT SetFuncDocString(unsigned int index,
OLECHAR FAR* szDocString);
Parameters
index
Index of the function.
szDocString
NULL-terminated documentation string.
Return Values
One of the values described in the following table is returned.
| Value | Description |
| S_OK | Success. |
| STG_E_INSUFFICIENTMEMORY | Out of memory. |
| E_OUTOFMEMORY | Out of memory. |
| E_INVALIDARG | One or more of the parameters is invalid. |
| E_ACCESSDENIED | Cannot write to the destination. |
| 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.