DbgHelpSymInitialize Method

[DllImportAttribute("DbgHelp.dll", CharSet = CharSet.Auto, BestFitMapping = false, 
	ThrowOnUnmappableChar = true, SetLastError = true)]
public static bool SymInitialize(
	IntPtr hProcess,
	string userSearchPath,
	bool fInvadeProcess
)

<DllImportAttribute("DbgHelp.dll", CharSet := CharSet.Auto, BestFitMapping := false, 
	ThrowOnUnmappableChar := true, SetLastError := true>]
Public Shared Function SymInitialize ( 
	hProcess As IntPtr,
	userSearchPath As String,
	fInvadeProcess As Boolean
) As Boolean

Dim hProcess As IntPtr
Dim userSearchPath As String
Dim fInvadeProcess As Boolean

Dim returnValue As Boolean

returnValue = DbgHelp.SymInitialize(hProcess, 
	userSearchPath, fInvadeProcess)

public:
[DllImportAttribute(L"DbgHelp.dll", CharSet = CharSet::Auto, BestFitMapping = false, 
	ThrowOnUnmappableChar = true, SetLastError = true)]
static bool SymInitialize(
	IntPtr hProcess, 
	String^ userSearchPath, 
	bool fInvadeProcess
)

[<DllImportAttribute("DbgHelp.dll", CharSet = CharSet.Auto, BestFitMapping = false, 
	ThrowOnUnmappableChar = true, SetLastError = true)>]
static member SymInitialize : 
        hProcess : IntPtr * 
        userSearchPath : string * 
        fInvadeProcess : bool -> bool 

No code example is currently available or this language may not be supported.

Parameters

hProcess  IntPtr

A handle that identifies the caller.

This value should be unique and nonzero, but need not be a process handle, However, if you do use a process handle, be sure to use the correct handle.

If the application is a debugger, use the process handle for the process being debugged.

Do not use the handle returned by GetCurrentProcess when debugging another process, because calling functions like SymLoadModuleEx(IntPtr, IntPtr, String, String, UInt64, Int32, IntPtr, SymLoadModuleFlags) can have unexpected results.

userSearchPath  String

The path, or series of paths separated by a semicolon (;), that is used to search for symbol files.

If this parameter is , the library attempts to form a symbol path from the following sources:

The current working directory of the application.

The _NT_SYMBOL_PATH environment variable.

The _NT_ALTERNATE_SYMBOL_PATH environment variable.

fInvadeProcess  Boolean

If this value is , enumerates the loaded modules for the process and effectively calls the SymLoadModule64 function for each module.

Return Value

If the function fails, the return value is .

Reference