Edit

IDebugStackFrame2::EnumProperties

  • Article

Creates an enumerator for properties associated with the stack frame, such as local variables.

Syntax

int EnumProperties ( 
   enum_DEBUGPROP_INFO_FLAGS   dwFieldSpec,
   uint                        nRadix,
   ref Guid                    refiid,
   uint                        dwTimeout,
   out uint                    pcelt,
   out IEnumDebugPropertyInfo2 ppEnum
);

Parameters

dwFieldSpec
[in] A combination of flags from the DEBUGPROP_INFO_FLAGS enumeration that specifies which fields in the enumerated DEBUG_PROPERTY_INFO structures are to be filled in.

nRadix
[in] The radix to be used in formatting any numerical information.

refiid
[in] A GUID of a filter used to select which DEBUG_PROPERTY_INFO structures are to be enumerated, such as guidFilterLocals.

dwTimeout
[in] Maximum time, in milliseconds, to wait before returning from this method. Use INFINITE to wait indefinitely.

pcelt
[out] Returns the number of properties enumerated. This is the same as calling the GetCount method.

ppEnum
[out] Returns an IEnumDebugPropertyInfo2 object containing a list of the desired properties.

Return Value

If successful, returns S_OK; otherwise, returns an error code.

Remarks

Because this method allows all selected properties to be retrieved with a single call, it is faster than sequentially calling the GetDebugProperty and EnumChildren methods.

See also