ICreateTypeInfo::SetFuncDocString

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

Sets the documentation string for the function with the specified index.

Parameters

index: Index of the function.
szDocString: 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_INVALIDARG	One or more of the arguments is invalid.
E_ACCESSDENIED	Cannot write to the destination.
TYPE_E_ELEMENTNOTFOUND	The element cannot be found.

Comments

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.