IDebugSymbols::GetImagePath method (dbgeng.h)

The GetImagePath method returns the executable image path.

Syntax

HRESULT GetImagePath(
  [out, optional] PSTR   Buffer,
  [in]            ULONG  BufferSize,
  [out, optional] PULONG PathSize
);

Parameters

[out, optional] Buffer

Receives the executable image path. This is a string that contains directories separated by semicolons (;). If Buffer is NULL, this information is not returned.

[in] BufferSize

Specifies the size, in characters, of the Buffer buffer.

[out, optional] PathSize

Receives the size, in characters, of the executable image path.

Return value

This method may also return other error values. See Return Values for more details.

Return code Description
S_OK
The method was successful.
S_FALSE
The method was successful. However, the buffer was not large enough to hold the executable image path and the path was truncated.

Remarks

The executable image path is used by the engine when searching for executable images.

The executable image path can consist of several directories separated by semicolons. These directories are searched in order.

Requirements

Requirement Value
Target Platform Desktop
Header dbgeng.h (include Dbgeng.h)

See also

AppendImagePath

IDebugSymbols

IDebugSymbols2

IDebugSymbols3

SetImagePath