ITypeInfo::GetVarDesc
A version of this page is also available for
4/8/2010
This method retrieves a VARDESC structure that describes the specified variable.
Syntax
HRESULT GetVarDesc(
unsigned int index,
VARDESC FAR* FAR* ppVarDesc
);
Parameters
- index
[in] 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.
- ppVarDesc
[out] On return, pointer to a pointer to a VARDESC that describes the specified variable.
Return Value
The following table shows the return values for this function.
| 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 VARDESC structure, use ITypeInfo::ReleaseVarDesc.
Example
CHECKRESULT(ptypeinfo->GetVarDesc(i, &pvardesc));
idMember = pvardesc->memid;
CHECKRESULT(ptypeinfo->GetDocumentation(idMember, &bstrName, NULL, NULL,
NULL));
ptypeinfo->ReleaseVarDesc(pvardesc);
Requirements
| Header | oaidl.h, oaidl.idl |
| Library | oleaut32.lib, uuid.lib |
| Windows Embedded CE | Windows CE 2.0 and later |
| Windows Mobile | Windows Mobile Version 5.0 and later |