ローカル キャッシュからファイルとディレクトリを削除します。 コンテナー 項目を削除すると、含まれるすべての項目が再帰的に削除されます。
構文
HRESULT DeleteItems(
[in] LPCWSTR *rgpszPaths,
[in] ULONG cPaths,
[in] DWORD dwFlags,
[in] BOOL bAsync,
[in] IOfflineFilesSimpleProgress *pIProgress
);
パラメーター
[in] rgpszPaths
削除するファイルまたはディレクトリの完全修飾 UNC パスへのポインターの配列。
[in] cPaths
rgpszPaths 配列内のパスの数。
[in] dwFlags
削除操作の動作を制御するフラグ。 このパラメーターには、次の 1 つ以上の値を指定できます。
OFFLINEFILES_DELETE_FLAG_NOAUTOCACHED (0x00000001)
自動的にキャッシュされたアイテムは削除しないでください。 既定の動作では、自動的にキャッシュされたアイテムが削除されます。
OFFLINEFILES_DELETE_FLAG_NOPINNED (0x00000002)
ピン留めされたアイテムは削除しないでください。 既定の動作では、ピン留めされたアイテムを削除します。
OFFLINEFILES_DELETE_FLAG_DELMODIFIED (0x00000004)
キャッシュ内でローカルに変更された場合でも削除します。 既定の動作では、同期されていないローカル変更を含むファイルは削除されません。
OFFLINEFILES_DELETE_FLAG_ADMIN (0x80000000)
管理者は、アクセス権に関係なく、すべてのファイルを列挙および削除できます。 このフラグが設定されていて、呼び出し元が管理者でない場合、関数は失敗します。
[in] bAsync
操作を非同期に実行するかどうかを示します。 このパラメーターが TRUE の場合、操作は非同期操作にスケジュールされ、関数は直ちにを返します。 このパラメーターが FALSE の場合、関数は操作の完了時に を返します。
[in] pIProgress
操作中に進行状況イベントを受信するイベント シンクへのインターフェイス。 イベントが必要ない場合、このパラメーターは NULL になる可能性があります。 非同期操作には、イベント シンクを指定することを強くお勧めします。 非同期操作が完了したときに通知を受け取る唯一の方法は、進行状況の実装です。
戻り値
成功した場合 はS_OK を返し、それ以外の場合はエラー値を返します。
操作が HRESULT_FROM_WIN32(ERROR_CANCELLED) 取り消された場合は を返します。
操作中にエラーが発生した場合は、HRESULT_FROM_WIN32(ERROR_MORE_DATA) を返します。 発生したエラーを検出するには、 IOfflineFilesSimpleProgress::ItemResult コールバック メソッドを使用します。
注釈
呼び出し元は、削除するファイルとディレクトリへの十分なアクセス権を持っている必要があります。
実行中に削除操作が取り消された場合、その時点に処理されたファイルに対する変更はロールバックされません。
ディレクトリに対する削除操作で、含まれているすべてのファイルまたはディレクトリを削除できない場合 (アクセスが拒否された場合など)、指定されたディレクトリ エントリは削除されません。 その時点まで削除されたすべてのファイルとディレクトリは削除されたままになります。
ファイルはローカル キャッシュからのみ削除されます。 ネットワーク サーバー上の関連ファイルは影響を受けません。
削除されたファイルは、ごみ箱から回復できません。 オフラインで使用できるようにするには、削除されたファイルを再キャッシュする必要があります。
rgpszPaths パラメーターにパスが 1 つだけ指定され、そのパスが 1 つのファイルに対する場合、戻り値はその単一の削除操作の結果を示します。 それ以外の場合、呼び出し元は次の一覧で進行状況コールバック メソッドを実装し、 IOfflineFilesSimpleProgress::ItemResult メソッドを監視して、処理された各ファイルとディレクトリの結果を取得する必要があります。
| 進行状況イベント インターフェイス | メソッド | 説明 |
|---|---|---|
| IOfflineFilesProgress | 開始 | 操作の開始時に呼び出されます。 |
| IOfflineFilesSimpleProgress | ItemBegin | 各ファイルの処理の開始時に呼び出されます。 |
| IOfflineFilesSimpleProgress | ItemResult | 各ファイルが削除された後に呼び出されます。 |
| IOfflineFilesProgress | QueryAbort | 同期操作中に定期的に呼び出され、キャンセル要求を検出します。 |
| IOfflineFilesProgress | End | 操作の最後に呼び出されます。 |
要件
| 要件 | 値 |
|---|---|
| サポートされている最小のクライアント | Windows Vista |
| サポートされている最小のサーバー | Windows Server 2008 |
| 対象プラットフォーム | Windows |
| ヘッダー | cscobj.h |
| [DLL] | CscSvc.dll;CscObj.dll |