Función CfSetPinState (cfapi.h)

Esta función establece el estado de anclaje de un marcador de posición, que representa la intención de un usuario. Cualquier aplicación, no solo el proveedor de sincronización, puede llamar a esta función.

Syntax

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 un identificador sin acceso es suficiente. El autor de la llamada debe tener acceso READ_DATA o WRITE_DAC al marcador de posición. De lo contrario, se produce 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 valores PinState válidos, consulte CF_PIN_STATE.

[in] PinFlags

Marcas de estado de anclaje. Establezca PinFlags en uno de los siguientes valores:

• Si especifica CF_SET_PIN_FLAG_RECURSE, la plataforma aplica el estado de anclaje a FileHandle y cada archivo recursivamente debajo de él. Esta marca solo es relevante si FileHandle es un identificador de un directorio.
• Si especifica CF_SET_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 especifica CF_SET_PIN_FLAG_RECURSE_STOP_ON_ERROR, la plataforma detiene la recursividad cuando encuentra el primer error. De lo contrario, la plataforma omite el error y continúa la recursividad.

Use CF_SET_PIN_FLAG_NONE para especificar ninguna marca.

[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 ejecuta correctamente, devuelve S_OK. De lo contrario, devuelve un código de error HRESULT .

Observaciones

Al especificar y combinar un FileHandle asincrónico con Superpuesto, la plataforma puede realizar la llamada de forma asincrónica.

Debe inicializar la estructura superpuesta con un evento en el que esperar. Si esta función devuelve HRESULT_FROM_WIN32(ERROR_IO_PENDING), puede esperar mediante GetOverlappedResult. Si no especifica este parámetro, la plataforma realiza la llamada API de forma sincrónica, independientemente de cómo haya creado el identificador.

Requisitos

Consulte también

GetOverlappedResult

CF_PIN_STATE

CF_SET_PIN_FLAGS