IDebugSymbols::GetSourcePathElement method

The GetSourcePathElement method returns an element from the source path.

Syntax


HRESULT GetSourcePathElement(
  [in]            ULONG  Index,
  [out, optional] PSTR   Buffer,
  [in]            ULONG  BufferSize,
  [out, optional] PULONG ElementSize
);

Parameters

Index [in]

Specifies the index of the element in the source path that will be returned. The source path is a string that contains elements separated by semicolons (;). The index of the first element is zero.

Buffer [out, optional]

Receives the source path element. Each source path element can be a directory or a source server. If Buffer is NULL, this information is not returned.

BufferSize [in]

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

ElementSize [out, optional]

Receives the size, in characters, of the source path element.

Return value

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

Return codeDescription
S_OK

The method was successful.

E_NOINTERFACE

The source path contains fewer than Index elements.

 

Remarks

The source path is used by the engine when searching for source files.

For more information about manipulating the source path, see Using Source Files. For an overview of the source path and its syntax, see Source Path.

Requirements

Target platform

Header

Dbgeng.h (include Dbgeng.h)

See also

IDebugSymbols
IDebugSymbols2
IDebugSymbols3
AppendSourcePath
GetSourcePath

 

 

Send comments about this topic to Microsoft

Show: