Función CfSetPinState (cfapi.h)

  • Artículo

Esto establece el estado de anclaje de un marcador de posición, que se usa para representar la intención de un usuario. Cualquier aplicación (no solo el proveedor de sincronización) puede llamar a esta función.

Sintaxis

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

Parámetros

[in] FileHandle

Identificador del archivo de marcador de posición. La plataforma sincroniza correctamente la operación con otras solicitudes activas. Un atributo o identificador sin acceso es suficiente. El autor de la llamada debe tener READ_DATA o WRITE_DAC acceso al marcador de posición; de lo contrario, se producirá un error en la operación con STATUS_CLOUD_FILE_ACCESS_DENIED.

[in] PinState

Estado de anclaje del archivo de marcador de posición. Para obtener una lista de los valores válidos de PinState , consulte CF_PIN_STATE.

[in] PinFlags

Marcas de estado de anclaje. PinFlags se puede establecer en los valores siguientes:

  • Si se especifica CF_PIN_FLAG_RECURSE , la plataforma aplica el estado de anclaje a FileHandle y cada archivo de forma recursiva debajo de él (relevante solo si FileHandle es un identificador de un directorio).
  • Si se especifica CF_PIN_FLAG_RECURSE_ONLY , la plataforma aplica el estado de anclaje a todos los archivos de forma recursiva debajo de FileHandle, pero no a FileHandle .
  • Si se especifica CF_PIN_FLAG_RECURSE_STOP_ERROR , la plataforma detendrá la recursividad al encontrar el primer error. De lo contrario, la plataforma omite el error y continúa la recursividad.

[in, out, optional] Overlapped

Permite que la llamada se realice de forma asincrónica. Consulte la sección Comentarios para obtener más detalles.

Valor devuelto

Si esta función se realiza correctamente, devuelve S_OK. De lo contrario, devuelve un código de error de HRESULT.

Comentarios

Cuando se especifica y se combina con un FileHandle asincrónico, Superpuesta permite a la plataforma realizar la llamada de forma asincrónica.

El autor de la llamada debe haber inicializado la estructura superpuesta con un evento en el que esperar. Si devuelve HRESULT_FROM_WIN32(ERROR_IO_PENDING), el autor de la llamada puede esperar mediante GetOverlappedResult. Si no se especifica, la plataforma realizará la llamada API de forma sincrónica, independientemente de cómo se haya creado el identificador.

Requisitos

Requisito Value
Cliente mínimo compatible Windows 10, versión 1709 [solo aplicaciones de escritorio]
Servidor mínimo compatible Windows Server 2016 [solo aplicaciones de escritorio]
Plataforma de destino Windows
Encabezado cfapi.h
Library CldApi.lib
Archivo DLL CldApi.dll

Consulte también

GetOverlappedResult

CF_PIN_STATE

CF_SET_PIN_FLAGS