Win32 API 日本語リファレンス
ホーム › Storage.CloudFilters › CF_OPERATION_PARAMETERS

CF_OPERATION_PARAMETERS

構造体
📘 Microsoft Learn (日本語) · English
サイズx64: 16 バイト / x86: 8 バイト

サイズ=各フィールドのバイト数(x64/x86 で異なる場合は x64/x86 と併記)。x64/x86 列=フィールドのバイトオフセット(HSPで dupptr / lpoke / wpoke 等に使用)。

フィールド

フィールド型サイズx64x86説明
ParamSizeDWORD4+0+0本構造体のバイトサイズ。
Anonymous_Anonymous_e__Union8/4+8+4操作種別に応じたパラメータを保持する共用体。

共用体: _Anonymous_e__Union x64 8B / x86 4B

フィールド型サイズx64x86説明
TransferData_TransferData_e__Struct8/4+0+0

同期プロバイダーは、プレースホルダーファイルをハイドレートするために TRANSFER_DATA を実行します。この操作は、FETCH_DATA コールバックまたは VALIDATE_DATA コールバックへの応答として実行できるほか、コールバックのコンテキスト外での先行的なバックグラウンドハイドレーション処理の一環として実行することもできます。

この API は、ALWAYS_FULL 未満のハイドレーションポリシーをサポートする同期プロバイダーにのみ適用されます。それ以外の場合、操作は ERROR_CLOUD_FILE_INVALID_REQUEST で失敗します。

同期プロバイダーは、TRANSFER_DATA 操作の対象となるファイルに対して WRITE_DATA または WRITE_DAC アクセス権を持っている必要があります。それ以外の場合、操作は ERROR_CLOUD_FILE_ACCESS_DENIED で失敗します。

この操作を実行するには:

  • OpInfo.Type を CF_OPERATION_TYPE_TRANSFER_DATA に設定しなければなりません。
  • OpParams.ParamSize は、OpParams.TransferData のサイズに OpParams.TransferData のオフセットを加えた正確な値でなければなりません。
  • OpParams.TransferData.Flags は CF_OPERATION_TRANSFER_DATA_FLAG_NONE に設定しなければなりません。
  • 同期プロバイダーがプレースホルダーファイルにデータを転送する場合、OpParams.TransferData.CompletionStatus は STATUS_SUCCESS に設定しなければなりません。同期プロバイダーが何らかの理由でハイドレーション要求の処理に失敗し、ハイドレーションを再開したくない場合は、CompletionStatus に STATUS_CLOUD_FILE_* のステータスを設定しなければなりません。STATUS_SUCCESS を除き、STATUS_CLOUD_FILE_* の範囲外で返されたステータスコードは、プラットフォームによって STATUS_CLOUD_FILE_UNSUCCESSFUL に変換されます。
  • OpParams.TransferData.CompletionStatus が STATUS_SUCCESS の場合、OpParams.TransferData.Buffer は有効なユーザーモードバッファーを指していなければならず、少なくとも OpParams.TransferData.Length バイトのサイズが必要です。それ以外の場合、このバッファーフィールドは無視されます。
  • OpParams.TransferData.Offset と OpParams.TransferData.Length は、同期プロバイダーがデータを転送するプレースホルダー内の範囲を表します。同期プロバイダーが要求されたすべてのデータを一度に返す必要はありません。また、要求より多くのデータを返しても構いません。たとえば、パフォーマンスなどの理由で、同期プロバイダーが余分に読み取ることもできます。同期プロバイダーは、同じ FETCH_DATA コールバックへの応答として TRANSFER_DATA 操作を複数回繰り返し実行することもできます。唯一の要件は、オフセットと長さの両方が 4KB 境界に整列していることです。ただし、指定した範囲が論理ファイルサイズ (EoF) で終わる場合は、結果の範囲が論理ファイルサイズ以上で終わる限り、長さが 4KB 境界に整列している必要はありません。

操作の完了時:

  • 同期プロバイダーが同期ルートの登録時に VALIDATION_REQUIRED を指定していない場合。

転送が成功した場合、転送の結果として必要なバイトをすべて受け取ったプレースホルダーファイルに対する保留中のユーザー IO 要求は完了します。それ以外の場合、未完了のユーザー IO 要求は最新のハイドレーション状態を反映するように更新されます。転送が失敗した場合、オフセットと長さで示される範囲と重なるプレースホルダーファイルへの保留中のユーザー IO 要求は、OpParams.TransferData.CompletionStatus で失敗します。

同期プロバイダーが同期ルートの登録時に VALIDATION_REQUIRED を指定している場合、その範囲のデータが ACK_DATA 操作によって同期プロバイダーから肯定的に確認されるまで、プラットフォームはそれ以上の処理を行いません。

RetrieveData_RetrieveData_e__Struct8/4+0+0

同期プロバイダーは、以前にプレースホルダーへ転送されたデータの整合性を検証するために、プレースホルダーのハイドレーションの一環として RETRIEVE_DATA 操作を実行します。この操作は、FETCH_DATA コールバックまたは VALIDATE_DATA コールバックへの応答として実行できるほか、コールバックのコンテキスト外での先行的なバックグラウンドハイドレーション処理の一環として実行することもできます。

この API は、ALWAYS_FULL 未満のハイドレーションポリシーをサポートする同期プロバイダーにのみ適用されます。それ以外の場合、操作は STATUS_CLOUD_FILE_NOT_SUPPORTED で失敗します。

この操作を実行するには、同期プロバイダーは同期ルートの登録時にハイドレーションポリシー修飾子 VALIDATE_REQUIRED を指定している必要があります。それ以外の場合、操作は STATUS_CLOUD_FILE_NOT_SUPPORTED で失敗します。

同期プロバイダーは、RETRIEVE_DATA 操作の対象となるファイルに対して READ_DATA または WRITE_DAC アクセス権を持っている必要があります。それ以外の場合、操作は STATUS_CLOUD_FILE_ACCESS_DENIED で失敗します。

この操作を実行するには:

  • OpInfo.Type を CF_OPERATION_TYPE_RETRIEVE_DATA に設定しなければなりません。
  • OpParams.ParamSize は、OpParams.RetrieveData のサイズに OpParams.RetrieveData のオフセットを加えた正確な値でなければなりません。
  • OpParams.RetrieveData.Flags は CF_OPERATION_RETRIEVE_DATA_FLAG_NONE に設定しなければなりません。
  • OpParams.RetrieveData.Buffer は有効なユーザーモードバッファーを指し、少なくとも OpParams.RetrieveData.Length バイトのサイズでなければなりません。操作が正常に完了すると、TRANSFER_DATA によって以前にプレースホルダーへ転送されたデータを受け取ります。
  • OpParams.RetrieveData.Offset と OpParams.RetrieveData.Length は、同期プロバイダーがデータを取得するプレースホルダー内の範囲を表します。要求する範囲は、RETRIEVE_DATA 操作の前に TRANSFER_DATA 操作によって完全にハイドレートされている必要があります。そうでない場合、操作は STATUS_CLOUD_FILE_INVALID_REQUEST で失敗します。オフセットと長さの両方が 4KB 境界に整列します。ただし、指定した範囲が論理ファイルサイズ (EoF) で終わる場合は、論理ファイルサイズ以上で終わる限り、長さが 4KB 境界に整列している必要はありません。
  • 操作が正常に完了すると、OpParams.RetrieveData.ReturnedLength に実際に取得されたバイト数が返されます。
AckData_AckData_e__Struct8/4+0+0

同期プロバイダーは、以前にプラットフォームへ転送されたデータの整合性を検証した後、プレースホルダーのハイドレーションの一環として ACK_DATA 操作を実行します。この操作は、FETCH_DATA コールバックまたは VALIDATE_DATA コールバックへの応答として実行できるほか、コールバックのコンテキスト外での先行的なバックグラウンドハイドレーション処理の一環として実行することもできます。

この API は、ALWAYS_FULL 未満のハイドレーションポリシーをサポートする同期プロバイダーにのみ適用されます。それ以外の場合、操作は STATUS_CLOUD_FILE_NOT_SUPPORTED で失敗します。

この操作を実行するには、同期プロバイダーは同期ルートの登録時にハイドレーションポリシー修飾子 VALIDATE_REQUIRED を指定している必要があります。それ以外の場合、操作は STATUS_CLOUD_FILE_NOT_SUPPORTED で失敗します。

同期プロバイダーは、ACK_DATA 操作の対象となるファイルに対して READ_DATA または WRITE_DAC アクセス権を持っている必要があります。それ以外の場合、操作は STATUS_CLOUD_FILE_ACCESS_DENIED で失敗します。

この操作を実行するには:

  • OpInfo.Type を CF_OPERATION_TYPE_ACK_DATA に設定しなければなりません。
  • OpParams.ParamSize は、OpParams.AckData のサイズに OpParams.AckData の Offset を加えた正確な値でなければなりません。
  • OpParams.AckData.Flags は CF_OPERATION_ACK_DATA_FLAG_NONE に設定しなければなりません。
  • 確認対象の範囲内のデータが正しいことを同期プロバイダーが検証した場合、OpParams.AckData.CompletionStatus は STATUS_SUCCESS に設定しなければなりません。同期プロバイダーが何らかの理由でデータの検証に失敗し、ハイドレーションを再開したくない場合は、CompletionStatus に STATUS_CLOUD_FILE_* のステータスを設定しなければなりません。STATUS_SUCCESS を除き、STATUS_CLOUD_FILE_* の範囲外で返されたステータスコードは、プラットフォームによって STATUS_CLOUD_FILE_UNSUCCESSFUL に変換されます。
  • OpParams.AckData.Offset と OpParams.AckData.Length は、同期プロバイダーがデータを確認するプレースホルダー内の範囲を表します。要求する範囲は、この操作の前に TRANSFER_DATA 操作によって完全にハイドレートされている必要はありません。Offset と Length の両方が 4KB 境界に整列します。ただし、指定した範囲が論理ファイルサイズ (EoF) で終わる場合は、論理ファイルサイズ以上で終わる限り、Length が 4KB 境界に整列している必要はありません。
  • CF_EOF と表記される -1 の Length は、無限 (つまりファイルの終端まで) を意味します。

ACK_DATA 操作が成功すると、その操作の結果として必要なバイトをすべて受け取ったプレースホルダーファイルに対する保留中のユーザー IO 要求は完了します。それ以外の場合、未完了のユーザー IO 要求は最新のハイドレーション状態を反映するように更新されます。ACK_DATA が失敗した場合、Offset と Length で示される範囲と重なるプレースホルダーファイルへの保留中のユーザー IO 要求は、CompletionStatus で失敗します。

RestartHydration_RestartHydration_e__Struct8/4+0+0

同期プロバイダーは、進行中のハイドレーションを再開するために RESTART_HYDRATION 操作を実行します。この操作は、FETCH_DATA コールバックまたは VALIDATE_DATA コールバックへの応答として実行できるほか、コールバックのコンテキスト外での先行的なバックグラウンドハイドレーション処理の一環として実行することもできます。

この API は、FULL ハイドレーションポリシーをサポートする同期プロバイダーにのみ適用されます。それ以外の場合、操作は STATUS_CLOUD_FILE_NOT_SUPPORTED で失敗します。

同期プロバイダーは、RESTART_HYDRATION 操作の対象となるファイルに対して WRITE_DATA または WRITE_DAC アクセス権を持っている必要があります。それ以外の場合、操作は STATUS_CLOUD_FILE_ACCESS_DENIED で失敗します。

この操作を実行するには:

  • OpInfo.Type を CF_OPERATION_TYPE_RESTART_HYDRATION に設定しなければなりません。
  • OpParams.ParamSize は、OpParams.RestartHydration のサイズに OpParams.RestartHydration の Offset を加えた正確な値でなければなりません。
  • OpParams.RestartHydration.Flags は CF_OPERATION_RESTART_HYDRATION_FLAG_NONE または CF_OPERATION_RESTART_HYDRATION_FLAG_MARK_IN_SYNC のいずれかに設定しなければなりません。
  • OpParams.RestartHydration.FsMetadata は省略可能です。指定した場合:
    • タイムスタンプフィールド (CreationTime、LastAccessTime、LastWriteTime、ChangeTime) の値が 0 の場合、ファイルの現在のタイムスタンプは変更されません。
    • FileAttributes の値が 0 の場合、ファイルの現在のファイル属性は変更されません。
    • FileSize に特別な値はありません。FileSize の値が 0 の場合、ファイルサイズは 0 に切り詰められます。
  • OpParams.RestartHydration.FileIdentity と OpParams.RestartHydration.FileIdentityLength は省略可能です。指定した場合、新しい ID がファイルに永続化されます。それ以外の場合、現在のファイル ID がそのまま維持されます。

同期プロバイダーは、プレースホルダー内のディスク上のデータが実際には無効であり、I/O 要求を満たすのに適さないと判断した場合に、この API を呼び出します。典型的なシナリオは、取得したデータが何らかの理由でチェックサム検証に失敗した場合です。もう 1 つの使用シナリオは、ハイドレーションの途中でクラウド上のファイル内容が実際に更新された場合です (かつ、同期プロバイダーがローカルのプレースホルダーのバージョンに対応する過去の内容をクラウドから取得できない場合)。

再開が成功すると、プレースホルダーは完全にデハイドレートされ、新しいメタデータがある場合はそれで更新されます。保留中のユーザー IO 要求がある場合は、到着したばかりであるかのように再処理され、その結果、同期プロバイダーは以前に受け取ったものとまったく同じ新しいコールバックを受け取ります。

ただし、何らかの理由で再開に失敗した場合、エラーが発生した箇所によってはプレースホルダーが不定の状態のまま残ることがあり、そのプレースホルダーに対する保留中のユーザー IO 要求はすべて同じエラーで失敗します。この場合にプラットフォームが保証するのは、今後そのプレースホルダーファイルにユーザーがアクセスすると同じコールバックがトリガーされるということだけです。

TransferPlaceholders_TransferPlaceholders_e__Struct8/4+0+0
AckDehydrate_AckDehydrate_e__Struct8/4+0+0
AckRename_AckRename_e__Struct8/4+0+0
AckDelete_AckDelete_e__Struct8/4+0+0

公式ドキュメント

プレースホルダーのファイルまたはフォルダーに対する操作の詳細なパラメーターです。この構造体で提供されるデータは、その操作の CF_OPERATION_TYPE に固有のものです。

出典・ライセンス: 上記「公式ドキュメント」の内容は Microsoft の Win32 API ドキュメント(MicrosoftDocs/sdk-api)を日本語に翻訳・改変したものです。© Microsoft Corporation. CC BY 4.0 で提供。
Microsoft 公式リファレンス: 英語 (en-us) · 日本語 (ja-jp) · 原文ソース (GitHub)

各言語での定義

#include <windows.h>

// CF_OPERATION_PARAMETERS  (x64 16 / x86 8 バイト)
typedef struct CF_OPERATION_PARAMETERS {
    DWORD ParamSize;
    _Anonymous_e__Union Anonymous;
} CF_OPERATION_PARAMETERS;
using System;
using System.Runtime.InteropServices;

[StructLayout(LayoutKind.Sequential, CharSet = CharSet.Unicode)]
public struct CF_OPERATION_PARAMETERS
{
    public uint ParamSize;
    public _Anonymous_e__Union Anonymous;
}
Imports System.Runtime.InteropServices

<StructLayout(LayoutKind.Sequential, CharSet:=CharSet.Unicode)>
Public Structure CF_OPERATION_PARAMETERS
    Public ParamSize As UInteger
    Public Anonymous As _Anonymous_e__Union
End Structure
import ctypes
from ctypes import wintypes

class CF_OPERATION_PARAMETERS(ctypes.Structure):
    _fields_ = [
        ("ParamSize", wintypes.DWORD),
        ("Anonymous", _Anonymous_e__Union),
    ]
#[repr(C)]
pub struct CF_OPERATION_PARAMETERS {
    pub ParamSize: u32,
    pub Anonymous: _Anonymous_e__Union,
}
import "golang.org/x/sys/windows"

type CF_OPERATION_PARAMETERS struct {
	ParamSize uint32
	Anonymous _Anonymous_e__Union
}
type
  CF_OPERATION_PARAMETERS = record
    ParamSize: DWORD;
    Anonymous: _Anonymous_e__Union;
  end;
const CF_OPERATION_PARAMETERS = extern struct {
    ParamSize: u32,
    Anonymous: _Anonymous_e__Union,
};
type
  CF_OPERATION_PARAMETERS {.bycopy.} = object
    ParamSize: uint32
    Anonymous: _Anonymous_e__Union
struct CF_OPERATION_PARAMETERS
{
    uint ParamSize;
    _Anonymous_e__Union Anonymous;
}

HSP用 定義

HSP3.7/3.8 は構造体機能が無いため4byte整数配列(dim)+peek/poke で操作(32/64bitでサイズ・位置が異なる場合はタブで分割)。IronHSP は NSTRUCT(#defstruct/stdim/->)で32/64bit共通。

; HSP3.7/3.8 は構造体機能が無いため、4byte整数の配列変数で操作します。(x86 レイアウト)
; CF_OPERATION_PARAMETERS サイズ: 8 バイト(x86)
dim st, 2    ; 4byte整数×2(構造体サイズ 8 / 4 切り上げ)
; ParamSize : DWORD (+0, 4byte)  st.0 = 値  /  値 = st.0   (lpoke/lpeek も可)
; Anonymous : _Anonymous_e__Union (+4, 4byte)  varptr(st)+4 を基点に操作(4byte:入れ子/配列)
; ※4byte境界の整数は添字 st.N(N=オフセット/4)で読み書き可。それ以外は peek/poke 系を使用。
; HSP3.7/3.8 は構造体機能が無いため、4byte整数の配列変数で操作します。(x64 レイアウト)
; CF_OPERATION_PARAMETERS サイズ: 16 バイト(x64)
dim st, 4    ; 4byte整数×4(構造体サイズ 16 / 4 切り上げ)
; ParamSize : DWORD (+0, 4byte)  st.0 = 値  /  値 = st.0   (lpoke/lpeek も可)
; Anonymous : _Anonymous_e__Union (+8, 8byte)  varptr(st)+8 を基点に操作(8byte:入れ子/配列)
; ※4byte境界の整数は添字 st.N(N=オフセット/4)で読み書き可。それ以外は peek/poke 系を使用。
; IronHSP は NSTRUCT(構造体)をサポート。32bit/64bit どちらでも同じコードで動作します。
#defstruct global CF_OPERATION_PARAMETERS
    #field int ParamSize
    #field byte Anonymous 8
#endstruct

stdim st, CF_OPERATION_PARAMETERS        ; NSTRUCT 変数を確保
st->ParamSize = 100
mes "ParamSize=" + st->ParamSize
; ※union フィールドは byte 列で確保(NSTRUCT は union 非対応)。必要に応じ手動でアクセス。