ITypeInfo::GetVarDesc

Important:
This is retired content. This content is outdated and is no longer being maintained. It is provided as a courtesy for individuals who are still using these technologies. This content may contain URLs that were valid when originally published, but now link to sites or pages that no longer exist.

This method retrieves a VARDESCstructure that describes the specified variable.

HRESULT GetVarDesc(
unsigned int
index
,
VARDESC FAR *FAR *
ppVarDesc
);

Parameters

index

Index of the variable whose description is to be returned. The indexshould be in the range of 0 to 1 less than the number of variables in this type.

ppVarDesc

On return, pointer to a pointer to a VARDESCthat describes the specified variable.

Return Values

One of the values described in the following table is returned.

Value	Description
S_OK	Success.
E_OUTOFMEMORY	Out of memory.
E_INVALIDARG	One or more of the parameters is invalid.
TYPE_E_IOERROR	The function could not read from the file.
TYPE_E_INVDATAREAD	Invalid data.
TYPE_E_UNSUPFORMAT	The type library has an older format.
TYPE_E_INVALIDSTATE	The type library could not be opened.

Remarks

To free the VARDESCstructure, use ReleaseVarDesc.

Example

CHECKRESULT(ptypeinfo->GetVarDesc(i,
&pvardesc)); idMember = pvardesc->memid;
CHECKRESULT(ptypeinfo->GetDocumentation(idMember, &bstrName,
NULL, NULL, NULL)); ptypeinfo->ReleaseVarDesc(pvardesc);

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.