Platform SDK: Debugging and Error Handling

SymGetOptions

The SymGetOptions function retrieves the current options mask.

DWORD SymGetOptions(VOID);

Parameters

This function has no parameters.

Return Values

The SymGetOptions function always returns the current options mask. Zero is a valid value and indicates that all options are turned off. The options values are masks that are combined using the OR operator to form a valid options value. The valid mask values are as follows.

Value Meaning
SYMOPT_CASE_INSENSITIVE All symbol searches are insensitive to case.
SYMOPT_UNDNAME All symbols are presented in undecorated form.
SYMOPT_DEFERRED_LOADS Symbols are not loaded until a reference is made requiring the symbols be loaded. This is the fastest, most efficient way to use the symbol handler.
SYMOPT_NO_CPP All C++ decorated symbols containing the symbol separator "::" are replaced by "__". This option exists for debuggers that cannot handle parsing real C++ symbol names.
SYMOPT_LOAD_LINES Loads line number information.

Remarks

The options value can be changed several times while the library is in use by an application. The option change affects all future calls to the symbol handler.

Remarks

To set the current options mask, use the SymSetOptions function.

Requirements

  Windows NT/2000: Requires Windows NT 4.0 or later.
  Windows 95/98: Requires Windows 95 or later. Available as a redistributable for Windows 95.
  Header: Declared in Dbghelp.h.
  Library: Use Dbghelp.lib.

See Also

Debug Help Library Overview, DbgHelp Functions