WdsCliFindFirstImage 関数 (wdsclientapi.h)

WDS サーバーに格納されているイメージの列挙を開始し、最初のイメージを参照する検索ハンドルを返します。

構文

HRESULT WDSCLIAPI WdsCliFindFirstImage(
  [in]  HANDLE  hSession,
  [out] PHANDLE phFindHandle
);

パラメーター

[in] hSession

WDS サーバーとのセッションへのハンドル。 これは 、WdsCliCreateSession 関数によって返されるハンドルでした。

[out] phFindHandle

検索ハンドルを受け取る HANDLE 値へのポインター。 関数が成功した場合、検索ハンドルは WDS サーバーに格納されている最初のイメージを参照します。 関数が失敗した場合、このパラメーターは変更されません。 WdsCliFindNextImage 関数を使用して、検索ハンドルの参照を次の画像に進めます。

メモ イメージに関する情報は、WDS クライアント API の画像情報関数を使用して、検索ハンドルからのみ取得できます。

 

戻り値

関数が成功した場合、戻り値は S_OK。

注釈

この関数を使用するには、セッションを認証する必要があります。 既存のセッションを認証するには、 WdsCliAuthorizeSession 関数を 呼び出します。

この関数によって返される WDS イメージ検索ハンドルを WdsCliFindNextImage 関数と共に使用して、WDS サーバーに格納されているイメージを列挙できます。

要件

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

こちらもご覧ください

Windows Deployment Services クライアント関数