Expand Minimize

SymEnumSourceFileTokensProc callback function

An application-defined callback function used with the SymEnumSourceFileTokens function which enumerates the source server version control information stored in the PDB for a module.

The PENUMSOURCEFILETOKENSCALLBACK type defines a pointer to this callback function. SymEnumSourceFileTokensProc is a placeholder for the application-defined function name.

Syntax


BOOL CALLBACK SymEnumSourceFileTokensProc(
  _In_  PVOID token,
  _In_  size_t size
);

Parameters

token [in]

A pointer to an opaque data structure that contains the version control information corresponding to a particular individual source file. The usage of this token is detailed below.

size [in]

The size of the data in the token parameter.

Return value

If the function returns TRUE, the enumeration will continue.

If the function returns FALSE, the enumeration will stop.

Remarks

An application can use this token to extract a source file from version control by calling SymGetSourceFileFromToken.

To get individual variables from the token, call SymGetSourceVarFromToken. The names of the variables differ based on the scripts used to create the tokens. See Source Server for details.

Requirements

Redistributable

DbgHelp.dll 6.8 or later

Header

Dbghelp.h

See also

DbgHelp Functions
Source Server
SymEnumSourceFileTokens
SymGetSourceFileFromToken
SymGetSourceFile

 

 

Community Additions

ADD
Show:
© 2014 Microsoft