CfSetInSyncState 関数 (cfapi.h)

プレースホルダー ファイルまたはフォルダーの同期中の状態を設定します。

構文

HRESULT CfSetInSyncState(
  [in]                HANDLE               FileHandle,
  [in]                CF_IN_SYNC_STATE     InSyncState,
  [in]                CF_SET_IN_SYNC_FLAGS InSyncFlags,
  [in, out, optional] USN                  *InSyncUsn
);

パラメーター

[in] FileHandle

プレースホルダーへのハンドル。 プラットフォームは、操作を他のアクティブな要求と適切に同期します。 属性またはアクセスなしのハンドルで十分です。 呼び出し元には、プレースホルダー へのWRITE_DATA または WRITE_DAC アクセス権が必要です。

[in] InSyncState

同期中の状態。 InSyncState は、次のいずれかの値に設定できます。

• CF_IN_SYNC_STATE_NOT_IN_SYNCが指定されている場合、プラットフォームは API 呼び出しから正常に戻ると、プレースホルダーの同期中状態をクリアします。
• CF_IN_SYNC_STATE_IN_SYNCが指定されている場合、プラットフォームは API 呼び出しからの正常な戻り時にプレースホルダーの同期中状態を設定します。

[in] InSyncFlags

同期中の状態フラグ。 詳細については、「 CF_SET_IN_SYNC_FLAGS 」を参照してください。

[in, out, optional] InSyncUsn

入力時に指定すると、 InSyncUsn は、渡されたファイルと同じ USN 値が引き続き存在する場合にのみ同期設定を実行するようにプラットフォームに指示します。 これは、同期プロバイダーがクラウドに対してプレースホルダーの変更を同期するだけの競合を閉じるものですが、 CfSetInSyncState の呼び出しの前に、プレースホルダーが何らかの方法で変更されました。 入力時に の USN 値へのポインターの 0 渡しは、ポインターを渡すのと NULL 同じです。 返されると、 InSYncUsn は 同期状態を設定した後、最終的な USN 値を受け取ります。

戻り値

この関数が成功すると、 が返されます S_OK。 そうでない場合は、HRESULT エラー コードを返します。

要件

こちらもご覧ください

CF_IN_SYNC_STATE

CF_SET_IN_SYNC_FLAGS