SetupGetTargetPathW 関数 (setupapi.h)

  • [アーティクル]

[この機能は、「要件」セクションに示されているオペレーティング システムで使用できます。 今後のバージョンでは変更されるか、利用できなくなる場合もあります。 SetupAPI は、アプリケーションのインストールに使用されなくなりました。 代わりに、アプリケーション インストーラーを開発するために Windows インストーラーを使用します。 SetupAPI は、デバイス ドライバーのインストールに引き続き使用されます。]

SetupGetTargetPath 関数は、ファイル リスト セクションのターゲット ディレクトリを決定します。 ファイル リスト セクションには、[ファイルの コピー ] セクション、[ ファイルの削除 ] セクション、または [ ファイルの名前の変更 ] セクションを指定できます。 セクション内のすべてのファイルは、INF ファイルの DestinationDirs セクションに一覧表示されている 1 つのディレクトリに存在する必要があります。

構文

WINSETUPAPI BOOL SetupGetTargetPathW(
  [in]      HINF        InfHandle,
  [in]      PINFCONTEXT InfContext,
  [in]      PCWSTR      Section,
  [in, out] PWSTR       ReturnBuffer,
  [in]      DWORD       ReturnBufferSize,
  [in, out] PDWORD      RequiredSize
);

パラメーター

[in] InfHandle

DestinationDirs セクションを含む読み込み INF ファイルを処理します。

[in] InfContext

ターゲット ディレクトリを取得するファイル リスト セクション内の行を指定する INF コンテキストへの省略可能なポインター。 InfContext が NULL の場合は、Section パラメーターが使用されます。

[in] Section

ハンドルが InfHandle である INF ファイルのセクションの名前を指定する省略可能なパラメーター。 SetupGetTargetPath は、このセクションのターゲット ディレクトリを取得します。 InfContext が指定されている場合、Section パラメーターは無視されます。 InfContext も Section も指定されていない場合、関数は INF ファイルから既定のターゲット パスを取得します。 null で終わる文字列を使用する必要があります。

[in, out] ReturnBuffer

完全修飾ターゲット パスを受け取るバッファーへのオプションのポインター。 パスは で終わることが保証されています。 null で終わる文字列を使用する必要があります。 関数を 1 回呼び出して、必要なバッファー サイズを取得し、必要なメモリを割り当ててから、2 回目に関数を呼び出してデータを取得できます。 この手法を使用すると、バッファー サイズが不十分なため、エラーを回避できます。 「解説」を参照してください。 このパラメーターは、NULL でもかまいません。

[in] ReturnBufferSize

ReturnBuffer が指すバッファーのサイズ (文字単位)。 これには 、null ターミネータが含まれます。

[in, out] RequiredSize

ReturnBuffer が指すバッファーに必要なサイズを文字で受け取る変数へのオプションのポインター。 これには 、null ターミネータが含まれます。 必要な実際のサイズが ReturnBufferSize で指定された値より大きい場合、関数は失敗し、 GetLastError の呼び出しはERROR_INSUFFICIENT_BUFFERを返します。

戻り値

関数が成功した場合、戻り値は 0 以外の値になります。

関数が失敗した場合は、0 を返します。 詳細なエラー情報を得るには、GetLastError を呼び出します。

解説

この関数が NULL の ReturnBuffer で呼び出され、ReturnBufferSize が 0 の場合、この関数は、指定されたデータを保持するために必要なバッファー サイズを RequiredSize が指す変数に格納します。 こので関数が成功した場合、戻り値は 0 以外の値になります。 それ以外の場合、戻り値は 0 で、 GetLastError を呼び出すことで拡張エラー情報を取得できます。

注意

setupapi.h ヘッダーは、Unicode プリプロセッサ定数の定義に基づいて、この関数の ANSI または Unicode バージョンを自動的に選択するエイリアスとして SetupGetTargetPath を定義します。 encoding-neutral エイリアスの使用を encoding-neutral ではないコードと混在すると、コンパイル エラーまたはランタイム エラーが発生する不一致が発生する可能性があります。 詳細については、「 関数プロトタイプの規則」を参照してください。

要件

要件 値
サポートされている最小のクライアント Windows XP (デスクトップ アプリのみ)
サポートされている最小のサーバー Windows Server 2003 (デスクトップ アプリのみ)
対象プラットフォーム Windows
ヘッダー setupapi.h
Library Setupapi.lib
[DLL] Setupapi.dll

関連項目

関数

概要

SetupGetSourceFileLocation

SetupGetSourceFileSize

SetupGetSourceInfo