ITypeInfo::GetVarDesc (Windows CE 5.0)
This method retrieves a VARDESC structure that describes the specified variable.
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 Values
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
OS Versions: Windows CE 2.0 and later.
Header: Oaidl.h, Oaidl.idl.
Link Library: Oleaut32.lib, Uuid.lib.
See Also
ITypeInfo | ITypeInfo::ReleaseVarDesc | VARDESC
Send Feedback on this topic to the authors