IDebugSymbols::FindSourceFile メソッド (dbgeng.h)

[アーティクル]
08/07/2023

FindSourceFile メソッドは、指定したソースファイルのソースパスを検索します。

構文

HRESULT FindSourceFile(
  [in]            ULONG  StartElement,
  [in]            PCSTR  File,
  [in]            ULONG  Flags,
  [out, optional] PULONG FoundElement,
  [out, optional] PSTR   Buffer,
  [in]            ULONG  BufferSize,
  [out, optional] PULONG FoundSize
);

パラメーター

[in] StartElement

検索を開始するソースパス内の要素のインデックスを指定します。 StartElement より前のソースパス内のすべての要素は、検索から除外されます。最初の要素のインデックスは 0 です。 StartElement がソースパス内の要素の数以上の場合は、ファイリングシステムが直接チェックされます。

このパラメーターを FoundElement と共に使用して、ソースパス内の複数の一致をチェックできます。

[in] File

検索するファイルのパスとファイル名を指定します。

[in] Flags

検索フラグを指定します。これらのフラグの説明については、「 DEBUG_FIND_SOURCE_XXX」を参照してください。

フラグ DEBUG_FIND_SOURCE_TOKEN_LOOKUPは設定しないでください。このメソッドには検索にソースサーバーが含まれていないため、フラグ DEBUG_FIND_SOURCE_NO_SRCSRVは無視されます。

[out, optional] FoundElement

ファイルを含むソースパス内の要素のインデックスを受け取ります。ファイルが (ソースパスを使用していない) ファイリングシステムで直接見つかった場合は、 -1 が FoundElement に返されます。 FoundElement が NULL の場合、この情報は返されません。

[out, optional] Buffer

見つかったファイルのパスと名前を受け取ります。フラグ DEBUG_FIND_SOURCE_FULL_PATHが設定されている場合、これはファイルの完全な正規パス名です。それ以外の場合は、ファイルの検索に使用された File の末尾とソースパス内のディレクトリの連結です。 Buffer が NULL の場合、この情報は返されません。

[in] BufferSize

バッファー バッファーのサイズを文字数で指定します。

[out, optional] FoundSize

ファイルの名前のサイズを文字数で指定します。 FoundSize が NULL の場合、この情報は返されません。

戻り値

このメソッドは、エラー値を返す場合もあります。詳細については、「戻り値」を参照してください。

リターンコード	説明
S_OK	メソッドは正常に実行されました。
E_NOINTERFACE	ソースパスにファイルが見つかりませんでした。

注釈

エンジンでは、ファイルを検索するために、次の手順を順番に使用します。

ソースパス内の各ディレクトリについて、ディレクトリパスの末尾とファイルパスの先頭との間に重複を見つけようとします。たとえば、ソースパスにディレクトリ C:\a\b\c\d が含まれており、 File が c\d\e\samplefile.c の場合、ファイル C:\a\b\c\d\e\samplefile.c は一致します。
フラグDEBUG_FIND_SOURCE_BEST_MATCHが設定されている場合は、最も長い重なりを持つ一致が返されます。それ以外の場合は、最初の一致が返されます。
ソースパス内の各ディレクトリに対して、 ファイル がディレクトリに追加されます。一致するものが見つからない場合、このプロセスは繰り返され、最初のディレクトリがファイルパスの先頭から削除されるたびに実行されます。たとえば、ソースパスにディレクトリ C:\a\b が含まれており、 File が c\d\e\samplefile.c の場合、ファイル C:\a\b\e\samplefile.c は一致します。
最初に見つかった一致が返されます。
ファイル は、ファイリングシステムで直接検索されます。