SymGetSourceVarFromToken Function

Retrieves the value associated with the specified variable name from the Source Server token.

BOOL WINAPI SymGetSourceVarFromToken(
  __in          HANDLE hProcess,
  __in          PVOID Token,
  __in_opt      PCTSTR Params,
  __in          PCTSTR VarName,
  __out         PTSTR Value,
  __in          DWORD Size
);

Parameters

hProcess

A handle to a process. This handle must have been previously passed to the SymInitialize function.

Token

A pointer to the token.

Params

This parameter is unused.

VarName

The name of the variable token whose value you want to retrieve.

Value

A pointer to a buffer that receives the value associated with the variable token specified in the VarName parameter.

Size

The size of the Value buffer, in characters.

Return Value

If the function succeeds, the return value is TRUE.

If the function fails, the return value is FALSE. To retrieve extended error information, call GetLastError.

Remarks

All DbgHelp functions, such as this one, are single threaded. Therefore, calls from more than one thread to this function will likely result in unexpected behavior or memory corruption. To avoid this, you must synchronize all concurrent calls from more than one thread to this function.

To call the Unicode version of this function, define DBGHELP_TRANSLATE_TCHAR.

Requirements

Send comments about this topic to Microsoft

Build date: 9/25/2007