Share via

ICreateTypeInfo::SetFuncDocString

  • Article

A version of this page is also available for

Windows Embedded CE 6.0 R3

4/8/2010

This method sets the documentation string for a function.

Syntax

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

Parameters

  • index
    [in] Index of the function.
  • szDocString
    [in] Null-terminated 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_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

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

See Also

Reference

ICreateTypeInfo