CfSetPinState-Funktion (cfapi.h)

Diese Funktion legt den Pinstatus eines Platzhalters fest, der die Absicht eines Benutzers darstellt. Jede Anwendung, nicht nur der Synchronisierungsanbieter, kann diese Funktion aufrufen.

Syntax

HRESULT CfSetPinState(
  [in]                HANDLE           FileHandle,
  [in]                CF_PIN_STATE     PinState,
  [in]                CF_SET_PIN_FLAGS PinFlags,
  [in, out, optional] LPOVERLAPPED     Overlapped
);

Die Parameter

[in] FileHandle

Das Handle der Platzhalterdatei. Die Plattform synchronisiert den Vorgang ordnungsgemäß mit anderen aktiven Anforderungen. Ein Attribut oder kein Zugriffshandle reicht aus. Der Aufrufer muss über READ_DATA oder WRITE_DAC Zugriff auf den Platzhalter verfügen. Andernfalls schlägt der Vorgang mit STATUS_CLOUD_FILE_ACCESS_DENIED fehl.

[in] PinState

Der Pinstatus der Platzhalterdatei. Eine Liste gültiger PinState-Werte finden Sie unter CF_PIN_STATE.

[in] PinFlags

Die Pinstatuskennzeichnungen. Legen Sie PinFlags auf einen der folgenden Werte fest:

• Wenn Sie CF_SET_PIN_FLAG_RECURSE angeben, wendet die Plattform den Pinstatus auf FileHandle und jede Datei rekursiv darunter an. Dieses Flag ist nur relevant, wenn FileHandle ein Handle für ein Verzeichnis ist.
• Wenn Sie CF_SET_PIN_FLAG_RECURSE_ONLY angeben, wendet die Plattform den Pinstatus auf jede Datei rekursiv unter FileHandle an, aber nicht auf FileHandle selbst.
• Wenn Sie CF_SET_PIN_FLAG_RECURSE_STOP_ON_ERROR angeben, stoppt die Plattform die Rekursion, wenn der erste Fehler auftritt. Andernfalls überspringt die Plattform den Fehler und setzt die Rekursion fort.

Verwenden Sie CF_SET_PIN_FLAG_NONE , um keine Kennzeichnungen anzugeben.

[in, out, optional] Overlapped

Ermöglicht die asynchrone Ausführung des Aufrufs. Weitere Informationen finden Sie im Abschnitt "Hinweise ".

Rückgabewert

Wenn diese Funktion erfolgreich ist, wird sie zurückgegeben S_OK. Andernfalls wird ein HRESULT-Fehlercode zurückgegeben.

Bemerkungen

Wenn Sie ein asynchrones FileHandle mit "Overlapped" angeben und kombinieren, kann die Plattform den Aufruf asynchron ausführen.

Sie müssen die überlappende Struktur mit einem Ereignis initialisieren, auf das gewartet wird. Wenn diese Funktion HRESULT_FROM_WIN32(ERROR_IO_PENDING) zurückgibt, können Sie mit GetOverlappedResult warten. Wenn Sie diesen Parameter nicht angeben, führt die Plattform den API-Aufruf synchron aus, unabhängig davon, wie Sie das Handle erstellt haben.

Anforderungen

Siehe auch

GetOverlappedResult

CF_PIN_STATE

CF_SET_PIN_FLAGS