ICreateTypeInfo::SetVarDocString

This method sets the documentation string for a variable.

At a Glance

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

Syntax

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

Parameters

index

Index of the variable being documented.

szDocString

NULL-terminated documentation string to be set.

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_ELEMENTNOTFOUND The element was not found.