IDispatch::GetTypeInfo
A version of this page is also available for
4/8/2010
This method retrieves the type information for an object.
Syntax
HRESULT GetTypeInfo(
unsigned int iTInfo,
LCID lcid,
ITypeInfo FAR* FAR* ppTInfo
);
Parameters
- iTInfo
[in] Type information to return. Pass zero to retrieve type information for the IDispatch implementation.
- lcid
[in] Locale identifier for the type information. An object may be able to return different type information for different languages. This is important for classes that support localized member names. For classes that do not support localized member names, this parameter can be ignored.
- ppTInfo
[out] Receives a pointer to the requested type information object.
Return Value
The following table shows the return values for this function.
| Value | Description |
|---|---|
S_OK |
Success; the type information element exists. |
DISP_E_BADINDEX |
Failure; iTInfo parameter was not 0. |
TYPE_E_ELEMENTNOTFOUND |
Failure; iTInfo parameter was not 0. |
Example
The following code from the sample file Lines.cpp loads information from the type library and implements the member function GetTypeInfo.
// These lines are from CLines::Create load type information for the
// Lines collection from the type library.
hr = LoadTypeInfo(&pLines->m_ptinfo, IID_ILines);
if (FAILED(hr))
goto error;
// Additional code omitted for brevity.
// This function implements GetTypeInfo for the CLines collection.
STDMETHODIMP
CLines::GetTypeInfo(
UINT iTInfo,
LCID lcid,
ITypeInfo FAR* FAR* ppTInfo)
{
*ppTInfo = NULL;
if(iTInfo != 0)
return ResultFromScode(DISP_E_BADINDEX);
m_ptinfo->AddRef();
*ppTInfo = m_ptinfo;
return NOERROR;
}
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 |