ICreateTypeInfo::SetVarDocString
A version of this page is also available for
4/8/2010
This method sets the documentation string for a variable.
Syntax
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 Value
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
| Header | oaidl.h, oaidl.idl |
| Library | oleaut32.lib, uuid.lib |
| Windows Embedded CE | Windows CE 2.0 and later |
| Windows Mobile | Windows Mobile Version 5.0 and later |