Share via


ICreateTypeInfo::SetDocString

This method sets the documentation string displayed by type browsers.

HRESULT SetDocString( 
  OLECHAR FAR* pStrDoc
);

Parameters

  • pStrDoc
    [in] Pointer to the documentation string.

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_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

OS Versions: Windows CE 2.0 and later.
Header: Oaidl.h, Oaidl.idl.
Link Library: Oleaut32.lib, Uuid.lib.

See Also

ICreateTypeInfo

Last updated on Wednesday, April 13, 2005

© 2005 Microsoft Corporation. All rights reserved.