Función CfGetPlaceholderRangeInfo (cfapi.h)
Obtiene información de intervalo sobre un archivo o carpeta de marcador de posición.
Sintaxis
HRESULT CfGetPlaceholderRangeInfo(
[in] HANDLE FileHandle,
[in] CF_PLACEHOLDER_RANGE_INFO_CLASS InfoClass,
[in] LARGE_INTEGER StartingOffset,
[in] LARGE_INTEGER Length,
[out] PVOID InfoBuffer,
[in] DWORD InfoBufferLength,
[out, optional] PDWORD ReturnedLength
);
Parámetros
[in] FileHandle
Identificador del archivo de marcador de posición que se va a consultar.
[in] InfoClass
Tipos del intervalo de datos de marcador de posición.
[in] StartingOffset
Desplazamiento del punto inicial del intervalo de datos.
[in] Length
Longitud del intervalo de datos. Un proveedor puede especificar CF_EOF para Length para indicar que el intervalo para el que se solicita información es de StartingOffset al final del archivo.
[out] InfoBuffer
Puntero a un búfer que recibirá los datos. El búfer es una matriz de estructuras de CF_FILE_RANGE , que son pares de desplazamiento y longitud, que describen los intervalos solicitados.
[in] InfoBufferLength
Longitud de InfoBuffer en bytes.
[out, optional] ReturnedLength
Longitud del intervalo devuelto de datos de marcador de posición en InfoBuffer.
Valor devuelto
Si esta función se realiza correctamente, devuelve S_OK. De lo contrario, devuelve un código de error HRESULT . Algunos códigos de error comunes se enumeran en la tabla siguiente:
| Código de error | Significado |
|---|---|
| HRESULT_FROM_WIN32( ERROR_HANDLE_EOF ) | Esto significa que StartingOffset>= la posición del final del archivo. |
| HRESULT_FROM_WIN32( ERROR_MORE_DATA ) | Esto implica que la siguiente entrada de CF_FILE_RANGE no cabe en el búfer proporcionado. El autor de la llamada debe comprobar si se recibe alguna entrada o no con el valor InfoBufferWritten devuelto. |
Comentarios
A diferencia de la mayoría de las API de marcador de posición que toman un identificador de archivo, esta no modifica el archivo de ninguna manera, por lo que el identificador de archivo solo requiere READ_ATTRIBUTES acceso.
Requisitos
| 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 |