ICreateTypeInfo::SetDocString

HRESULT SetDocString(
  OLECHAR FAR*  pStrDoc  
);

Sets the documentation string displayed by type browsers.

Parameter

pStrDoc
Pointer to the documentation string.

Return Value

The return value of the returned HRESULT is one of the following:

Return value Meaning
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.

Comments

The documentation string is a brief description of the type description being created.