This method sets the documentation string for a variable.
HRESULT SetVarDocString( unsigned int index,OLECHAR FAR* szDocString);
Parameters
- index
[in] Index of the variable being documented. - szDocString
[in] Null-terminated documentation string to be set.
Return Values
The following table shows the return values for this function.
| Value | Description |
|---|---|
| S_OK | Success. |
| STG_E_INSUFFICIENTMEMORY | Out of memory. |
| E_OUTOFMEMORY | Out of memory. |
| E_ACCESSDENIED | Cannot write to the destination. |
| TYPE_E_ELEMENTNOTFOUND | The element was not found. |
Requirements
OS Versions: Windows CE 2.0 and later.
Header: Oaidl.h, Oaidl.idl.
Link Library: Oleaut32.lib, Uuid.lib.
See Also
Send Feedback on this topic to the authors