SymbolServerSetOptions function

[This function is not supported and may be altered or unavailable in the future.]

An entry point to the symbol server DLL. It is used to set the symbol server options.

The PSYMBOLSERVERSETOPTIONSPROC type defines a pointer to this callback function. SymbolServerSetOptions is a placeholder for the library-defined function name.

Syntax


BOOL CALLBACK SymbolServerSetOptions(
  _In_ UINT_PTR options,
  _In_ ULONG64  data
);

Parameters

options [in]

The option to be set (see Remarks).

data [in]

The server-specific option data. The format of this data depends on the value of options (see Remarks).

Return value

The server can return TRUE to indicate success, or return FALSE and call the SetLastError function to indicate an error condition.

Remarks

To call this function, you must use the LoadLibrary function to load the DLL and the GetProcAddress function to get the address of the function. The default implementation is in Symsrv.dll.

If you are using Symsrv.dll as your symbol server, the options parameter should be one of the following values.

idMeaning
SSRVOPT_CALLBACKCallback function. The data parameter contains a pointer to the callback function. If data is NULL, any previously-set callback function is ignored.
SSRVOPT_DOWNSTREAM_STOREThe data parameter contains a string that specifies the downstream store path. For more information, see Using SymSrv.

DbgHelp 6.0 and earlier:  This value is not supported.

SSRVOPT_FLAT_DEFAULT_STOREIf data is TRUE, SymSrv uses the default downstream store as a flat directory.

DbgHelp 6.1 and earlier:  This value is not supported.

SSRVOPT_FAVOR_COMPRESSEDIf data is TRUE, SymSrv uses symbols that do not have an address. By default, SymSrv filters out symbols that do not have an address.
SSRVOPT_NOCOPYIf data is TRUE, SymSrv will not verify that the path parameter passed by the SymbolServer function actually exists. In this case, SymbolServer will always return TRUE.
SSRVOPT_OVERWRITEIf data is TRUE, SymSrv will overwrite the downlevel store from the symbol store.

DbgHelp 6.1 and earlier:  This value is not supported.

SSRVOPT_PARAMTYPEData type of the id parameter passed to the SymbolServer function.

The data parameter is of type UINT_PTR and can be one of the following values:

SSRVOPT_DWORD (default)
SSRVOPT_DWORDPTR
SSRVOPT_GUIDPTR
SSRVOPT_PARENTWINThe data parameter is an HWND value that specifies the handle to the parent window that should be used for all dialog boxes and pop-ups. If data is NULL, SymSrv will use the desktop window as the parent (this is the default).
SSRVOPT_PROXYIf data is NULL, the default proxy server is used. Otherwise, data is a null-terminated string that specifies the name and port number of the proxy server. The name and port number are separated by a colon (:). For more information, see Symbol Servers and Internet Firewalls.

DbgHelp 6.0 and earlier:  This value is not supported.

SSRVOPT_RESETResets default options.
SSRVOPT_SECUREIf data is TRUE, SymSrv will not use the downstream store specified in _NT_SYMBOL_PATH.

DbgHelp 6.0 and earlier:  This value is not supported.

SSRVOPT_SETCONTEXTThe data parameter specifies the value passed to the SymbolServerCallback function in the context parameter.

DbgHelp 6.0 and earlier:  This value is not supported.

SSRVOPT_TRACESymSrv will provide debug trace information.

DbgHelp 5.1:  This value is not supported.

SSRVOPT_UNATTENDEDIf data is TRUE, SymSrv will not display dialog boxes or pop-ups. If data is FALSE, SymSrv will display these graphical features when making connections.

 

Requirements

Redistributable

DbgHelp.dll 5.1 or later

Header

DbgHelp.h

DLL

SymSrv.dll

Unicode and ANSI names

SymbolServerSetOptionsW (Unicode)

See also

DbgHelp Functions
SymbolServerGetOptions

 

 

Show: