ITypeInfo::GetNames
A version of this page is also available for
4/8/2010
This method retrieves the variable with the specified member identifier, or the name of the function and parameter names corresponding to the specified function identifier.
Syntax
HRESULT GetNames(
MEMBERID memid,
BSTR FAR* rgBstrNames,
unsigned int cMaxNames,
unsigned int FAR* pcNames
);
Parameters
- memid
[in] Identifier of the member whose name (or names) is to be returned.
- rgBstrNames
[out] Pointer to the caller-allocated array. On return, each of these lpcName elements is filled in to point to a BSTR that contains the name (or names) associated with the member.
- cMaxNames
[in] Length of the passed-in rgBstrNames array.
- pcNames
[out] On return, pointer to the number that represents the number of names in rgBstrNames array.
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. |
TYPE_E_WRONGTYPEKIND |
Type mismatch. |
TYPE_E_ELEMENTNOTFOUND |
The element was not found. |
Remarks
The caller must release the returned BSTR array.
If the member identifier identifies a property that is implemented with property functions, the property name is returned.
For property get functions, the names of the function and its parameters are always returned.
For property put and put reference functions, the right side of the assignment is unnamed.
If cMaxNames is less than is required to return all of the names of the parameters of a function, then only the names of the first cMaxNames –1 parameters are returned.
The names of the parameters are returned in the array in the same order that they appear elsewhere in the interface (for example, the same order in the parameter array associated with the FUNCDESC enumeration).
If the type description inherits from another type description, this function is recursive to the base type description, if necessary, to find the item with the requested member identifier.
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 |