IVssEnumObject::Next メソッド (vss.h)

  • [アーティクル]

Next メソッドは、列挙オブジェクトの指定したリストから、指定した数のオブジェクトを返します。

構文

HRESULT Next(
  [in]  ULONG           celt,
  [out] VSS_OBJECT_PROP *rgelt,
  [out] ULONG           *pceltFetched
);

パラメーター

[in] celt

列挙オブジェクトの一覧から rgelt バッファーに読み取る要素の数。

[out] rgelt

返されたオブジェクトを含む celtVSS_OBJECT_PROP 構造体を受け取る呼び出し元によって割り当てられたバッファーのアドレス。 このパラメーターは必須であり、NULL にすることはできません。

[out] pceltFetched

rgelt バッファーで返された要素の数。

戻り値

このメソッドの有効なリターン コードを次に示します。

値 意味
S_OK
 操作に成功しました。
S_FALSE
 返されるアイテムの数が、要求された数より少ない。
E_FAIL
 列挙子に内部エラーがあります。
E_POINTER
 必要なポインター パラメーターの 1 つが NULL です。

注釈

複数の VSS_OBJECT_PROP オブジェクトの戻り値を要求すると、S_FALSEの戻り値は列挙リストの末尾に達したことを示します。 リストに残っているオブジェクトよりも多くのオブジェクトが要求された場合、 Next は残りのすべてのオブジェクトを返し、 pceltFetched パラメーターを 0 以外の値に設定し、S_FALSEを返します。

出力 rgelt パラメーターは、 celtVSS_OBJECT_PROP 構造体を含む割り当てられた配列を指す必要があり、NULL にすることはできません。

呼び出し元は、rgelt パラメーターによって指されるVSS_OBJECT_PROP構造体の横に、IVssEnumObject::Next によって返されるシステム リソースを解放する必要があります。

呼び出し元は、返されるVSS_OBJECT_PROP構造体の VSS_SNAPSHOT_PROP または VSS_PROVIDER_PROP オブジェクト内のすべての文字列値に対して CoTaskMemFreeを使用する必要があります。

VSS_SNAPSHOT_PROPの場合は、手動で行うか、ユーティリティ関数 VssFreeSnapshotProperties を使用できます。

要件

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

こちらもご覧ください

IVssBackupComponents::Query

IVssEnumObject

VSS_OBJECT_PROP