ICreateTypeInfo::SetDocString
A version of this page is also available for
4/8/2010
This method sets the documentation string displayed by type browsers.
Syntax
HRESULT SetDocString(
OLECHAR FAR* pStrDoc
);
Parameters
- pStrDoc
[in] Pointer to the documentation string.
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_INVALIDSTATE |
The state of the type library is not valid for this operation. |
Remarks
The documentation string is a brief description of the type description being created.
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 |