ICreateTypeInfo::SetDocString

This method sets the documentation string displayed by type browsers.

At a Glance

Header file: Oaidl.h
Windows CE versions: 2.0 and later

Syntax

HRESULT SetDocString( OLECHAR FAR* pStrDoc );

Parameters

pStrDoc

Pointer to the 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_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.