Share via

IDebugContainerField::EnumFields

  • Article

Note

This article applies to Visual Studio 2015. If you're looking for the latest Visual Studio documentation, see Visual Studio documentation. We recommend upgrading to the latest version of Visual Studio. Download it here

Creates an enumerator for the fields of the container.

Syntax

HRESULT EnumFields(   
   FIELD_KIND         dwKindFilter,  
   FIELD_MODIFIERS    dwModifiersFilter,  
   LPCOLESTR          pszNameFilter,  
   NAME_MATCH         nameMatch,  
   IEnumDebugFields** ppEnum  
);  

int EnumFields(  
   enum_ FIELD_KIND      dwKindFilter,   
   enum_ FIELD_MODIFIERS dwModifiersFilter,   
   string                pszNameFilter,   
   NAME_MATCH            nameMatch,   
   out IEnumDebugFields  ppEnum  
);

Parameters

dwKindFilter
[in] A combination of FIELD_KIND constants that select the fields to be enumerated. Field kinds can describe storage types, such as class or primitive, or specific information, such as local, parameter, or "this" pointer.

dwModifiersFilter
[in] A combination of FIELD_MODIFIERS constants that select the fields to be enumerated. Field modifiers can be access permissions, such as public or private, or storage information, such as virtual, static, or final.

pszNameFilter
[in] The name of the field to be enumerated. This can be a null value if all fields are to be returned.

nameMatch
[in] A value from the NAME_MATCH enumeration that controls whether searching is case-sensitive or not.

ppEnum
[out] Returns an IEnumDebugFields object representing the list of fields. Returns a null value if there are no fields.

Return Value

If successful, returns S_OK or S_FALSE if there are no fields. Otherwise, returns an error code.

Remarks

The dwKindFilter, dwModifiersFilter, and pszNameFilter parameters can be combined, for example, to select all public virtual methods named "MyMethod".

See Also

IDebugContainerField
IEnumDebugFields
FIELD_KIND
FIELD_MODIFIERS
NAME_MATCH