Función CfGetPlaceholderInfo (cfapi.h)

Obtiene varias características de un archivo o carpeta de marcador de posición. Si el archivo no es un marcador de posición de archivos en la nube, se producirá un error en la API. Si se ejecuta correctamente, la información se devuelve según la InfoClass específica solicitada.

Sintaxis

HRESULT CfGetPlaceholderInfo(
  [in]            HANDLE                    FileHandle,
  [in]            CF_PLACEHOLDER_INFO_CLASS InfoClass,
  [out]           PVOID                     InfoBuffer,
  [in]            DWORD                     InfoBufferLength,
  [out, optional] PDWORD                    ReturnedLength
);

Parámetros

[in] FileHandle

Identificador del marcador de posición cuya información se consultará. A diferencia de la mayoría de las API de archivos en la nube que toman un identificador de archivo, esta no modifica el archivo de ninguna manera. Por lo tanto, el identificador de archivo solo requiere READ_ATTRIBUTES acceso.

[in] InfoClass

Información del marcador de posición. Se puede establecer en CF_PLACEHOLDER_STANDARD_INFO o en CF_PLACEHOLDER_BASIC_INFO.

[out] InfoBuffer

Puntero a un búfer que recibirá información sobre el marcador de posición.

[in] InfoBufferLength

Longitud de InfoBuffer, en bytes. Si el búfer no es lo suficientemente grande como para contener toda la información solicitada, la API devolverá tantos datos como pueda caber en el búfer y se producirá un error en la llamada a HRESULT_FROM_WIN32(ERROR_MORE_DATA).

[out, optional] ReturnedLength

Número de bytes devueltos en InfoBuffer.

Valor devuelto

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

Comentarios

La información del marcador de posición incluye los siguientes atributos:

Atributo	Descripción
OnDiskDataSize	Número total de bytes en el disco.
ValidatedDataSize	Número total de bytes sincronizados con la nube.
ModifiedDataSize	Número total de bytes que se han sobrescrito o anexado localmente, es decir, no sincronizados con la nube.
PropertiesSize	Número total de bytes en el disco que usan todos los blobs de propiedades.
PinState	Consulte CfSetPinState para obtener más información.
InSyncState	Consulte CfSetInSyncState para obtener más información.
FileId	Número no volátil de un volumen de 64 bits que identifica de forma única un archivo o directorio.
SyncRootFileId	Identificador de archivo del directorio raíz de sincronización en el que reside el archivo cuya información de marcador de posición se va a consultar.
FileIdentity	Un blob opaco proporcionado por el proveedor de sincronización a la plataforma cuando se creó el marcador de posición. La identidad de archivo se proporciona para todas las devoluciones de llamada del proveedor de sincronización.
FileIdentityLength	Longitud de la identidad del archivo en bytes.

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

CfSetPinState

CfSetInSyncState

CF_PLACEHOLDER_STANDARD_INFO

CF_PLACEHOLDER_BASIC_INFO