Share via

ICreateTypeInfo::SetFuncDocString

  • Article

This method sets the documentation string for a function.

HRESULT SetFuncDocString(
  unsigned int index, 
  OLECHAR FAR* szDocString
);

Parameters

  • index
    [in] Index of the function.
  • szDocString
    [in] Null-terminated 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_INVALIDARG One or more of the parameters is invalid.
E_ACCESSDENIED Cannot write to the destination.
TYPE_E_ELEMENTNOTFOUND The element cannot be found.

Remarks

The documentation string is a brief description of the function intended for use by tools such as type browsers. SetFuncDocString only needs to be used once for each property because all property accessor functions are identified by one name.

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.