CfSetPinState-Funktion (cfapi.h)
Dadurch wird der Pinstatus eines Platzhalters festgelegt, der zur Darstellung der Absicht eines Benutzers verwendet wird. 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
);
Parameter
[in] FileHandle
Das Handle der Platzhalterdatei. Die Plattform synchronisiert den Vorgang ordnungsgemäß mit anderen aktiven Anforderungen. Ein Attribut oder kein Zugriffshandle ist ausreichend. Der Aufrufer muss über READ_DATA oder WRITE_DAC Zugriff auf den Platzhalter verfügen, andernfalls tritt bei dem Vorgang ein Fehler mit STATUS_CLOUD_FILE_ACCESS_DENIED auf.
[in] PinState
Der Pinstatus der Platzhalterdatei. Eine Liste der gültigen PinState-Werte finden Sie unter CF_PIN_STATE.
[in] PinFlags
Die Pinzustandsflags. PinFlags können auf die folgenden Werte festgelegt werden:
- Wenn CF_PIN_FLAG_RECURSE angegeben ist, wendet die Plattform den Pin-Zustand auf FileHandle und jede datei rekursiv darunter an (nur relevant, wenn FileHandle ein Handle für ein Verzeichnis ist).
- Wenn CF_PIN_FLAG_RECURSE_ONLY angegeben ist, wendet die Plattform den Anheftungszustand rekursiv auf jede Datei unterhalb von FileHandle an, jedoch nicht auf FileHandle selbst.
- Wenn CF_PIN_FLAG_RECURSE_STOP_ERROR angegeben ist, beendet die Plattform die Rekursion, wenn der erste Fehler auftritt. Andernfalls überspringt die Plattform den Fehler und setzt die Rekursion fort.
[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 zurückgegeben S_OK. Andernfalls wird ein Fehlercode HRESULT zurückgegeben.
Hinweise
Bei Angabe und Kombination mit einem asynchronen FileHandle ermöglicht Overlapped der Plattform, den Aufruf asynchron auszuführen.
Der Aufrufer muss die überlappende Struktur mit einem Ereignis initialisiert haben, auf das gewartet werden soll. Wenn HRESULT_FROM_WIN32(ERROR_IO_PENDING) zurückgegeben wird, kann der Aufrufer mit GetOverlappedResult warten. Wenn nicht angegeben, führt die Plattform den API-Aufruf synchron aus, unabhängig davon, wie das Handle erstellt wurde.
Anforderungen
| Anforderung | Wert |
|---|---|
| Unterstützte Mindestversion (Client) | Windows 10, Version 1709 [nur Desktop-Apps] |
| Unterstützte Mindestversion (Server) | Windows Server 2016 [nur Desktop-Apps] |
| Zielplattform | Windows |
| Kopfzeile | cfapi.h |
| Bibliothek | CldApi.lib |
| DLL | CldApi.dll |