SymGetSourceFileToken Function

Debug Help Library

SymGetSourceFileToken Function

Retrieves token for the specified source file from the source server.

BOOL WINAPI SymGetSourceFileToken(
  __in          HANDLE hProcess,
  __in          ULONG64 Base,
  __in          PCTSTR FileSpec,
  __out         PVOID* Token,
  __in          DWORD* Size
);

Parameters

hProcess

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

Base

The base address of the module.

FileSpec

The name of the source file.

Token

A pointer to a buffer that receives the token.

Size

The size of the Token buffer, in bytes.

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

Redistributable

Requires DbgHelp.dll 6.2 or later.

Header

Declared in Dbghelp.h.

Library

Use Dbghelp.lib.

DLL

Requires Dbghelp.dll.

Unicode

Implemented as SymGetSourceFileTokenW (Unicode) and SymGetSourceFileToken (ANSI).

See Also

DbgHelp FunctionsSource Server


Send comments about this topic to Microsoft

Build date: 9/25/2007

© 2007 Microsoft Corporation. All rights reserved.