ICreateTypeInfo::SetVarDocString

This method sets the documentation string for a variable.

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.

Requirements

Runs on Versions Defined in Include Link to
Windows CE OS 2.0 and later Oaidl.h    

Note   This API is part of the complete Windows CE OS package as provided by Microsoft. The functionality of a particular platform is determined by the original equipment manufacturer (OEM) and some devices may not support this API.

 Last updated on Tuesday, July 13, 2004

© 1992-2000 Microsoft Corporation. All rights reserved.