Edit

IDebugSymbols3::GetScopeSymbolGroup2 method (dbgeng.h)

  • Article

The GetScopeSymbolGroup2 method returns a symbol group containing the symbols in the current target's scope.

Syntax

HRESULT GetScopeSymbolGroup2(
  [in]           ULONG                Flags,
  [in, optional] PDEBUG_SYMBOL_GROUP2 Update,
  [out]          PDEBUG_SYMBOL_GROUP2 *Symbols
);

Parameters

[in] Flags

Specifies a bit-set used to determine which symbols to include in the symbol group. To include all symbols, set Flags to DEBUG_SCOPE_GROUP_ALL. The following bit-flags determine which symbols are included.

Flag Description
DEBUG_SCOPE_GROUP_ARGUMENTS Include the function arguments for the current scope.
DEBUG_SCOPE_GROUP_LOCALS Include the local variables for the current scope.

[in, optional] Update

Specifies a previously created symbol group that will be updated to reflect the current scope. If Update is NULL, a new symbol group interface object is created.

[out] Symbols

Receives the symbol group interface object for the current scope. For details on this interface, see IDebugSymbolGroup

Return value

This method may also return error values. See Return Values for more details.

Return code Description
S_OK
 The method was successful.

Remarks

The Update parameter allows for efficient updates when stepping through code. Instead of creating and populating a new symbol group, the old symbol group can be updated.

For more information about scopes and symbol groups, see Scopes and Symbol Groups.

Requirements

Requirement Value
Target Platform Desktop
Header dbgeng.h (include Dbgeng.h)

See also

GetScope

IDebugSymbolGroup

IDebugSymbols3