Skip to content

Latest commit

 

History

History
134 lines (108 loc) · 2.92 KB

nf-oaidl-itypeinfo-getvardesc.md

File metadata and controls

134 lines (108 loc) · 2.92 KB
UID title description helpviewer_keywords old-location tech.root ms.assetid ms.date ms.keywords req.header req.include-header req.target-type req.target-min-winverclnt req.target-min-winversvr req.kmdf-ver req.umdf-ver req.ddi-compliance req.unicode-ansi req.idl req.max-support req.namespace req.assembly req.type-library req.lib req.dll req.irql targetos req.typenames req.redist ms.custom f1_keywords dev_langs topic_type api_type api_location api_name
NF:oaidl.ITypeInfo.GetVarDesc
ITypeInfo::GetVarDesc (oaidl.h)
Retrieves a VARDESC structure that describes the specified variable.
GetVarDesc
GetVarDesc method [Automation]
GetVarDesc method [Automation]
ITypeInfo interface
ITypeInfo interface [Automation]
GetVarDesc method
ITypeInfo.GetVarDesc
ITypeInfo::GetVarDesc
_oa96_ITypeInfo_GetVarDesc
automat.itypeinfo_getvardesc
oaidl/ITypeInfo::GetVarDesc
automat\itypeinfo_getvardesc.htm
automat
c4226d33-37ec-4e9a-87ce-92c4ff0e6cb3
12/05/2018
GetVarDesc, GetVarDesc method [Automation], GetVarDesc method [Automation],ITypeInfo interface, ITypeInfo interface [Automation],GetVarDesc method, ITypeInfo.GetVarDesc, ITypeInfo::GetVarDesc, _oa96_ITypeInfo_GetVarDesc, automat.itypeinfo_getvardesc, oaidl/ITypeInfo::GetVarDesc
oaidl.h
Windows
OaIdl.idl
Windows
19H1
ITypeInfo::GetVarDesc
oaidl/ITypeInfo::GetVarDesc
c++
APIRef
kbSyntax
COM
oaidl.h
ITypeInfo.GetVarDesc

ITypeInfo::GetVarDesc

-description

Retrieves a VARDESC structure that describes the specified variable.

-parameters

-param index [in]

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

-param ppVarDesc [out]

A VARDESC that describes the specified variable.

-returns

This method can return one of these values.

Return code Description
S_OK
Success.
E_INVALIDARG
One or more of the arguments is not valid.
E_OUTOFMEMORY
Insufficient memory to complete the operation.

-remarks

To free the VARDESC structure, use ReleaseVarDesc.

Examples

In the following example, the CHECKRESULT function is undefined. Replace this function with your error handling code.

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

-see-also

ITypeInfo