Função CfGetPlaceholderInfo (cfapi.h)
Obtém várias características de um arquivo ou pasta de espaço reservado. Se o arquivo não for um espaço reservado para arquivos de nuvem, a API falhará. Em caso de êxito, as informações são retornadas de acordo com o InfoClass específico solicitado.
Sintaxe
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
Um identificador para o espaço reservado cujas informações serão consultadas. Ao contrário da maioria das APIs de arquivos de nuvem que pegam um identificador de arquivo, essa não modifica o arquivo de forma alguma. Portanto, o identificador de arquivo requer apenas acesso READ_ATTRIBUTES .
[in] InfoClass
Informações de espaço reservado. Isso pode ser definido como CF_PLACEHOLDER_STANDARD_INFO ou CF_PLACEHOLDER_BASIC_INFO.
[out] InfoBuffer
Um ponteiro para um buffer que receberá informações sobre o espaço reservado.
[in] InfoBufferLength
O comprimento do InfoBuffer, em bytes. Se o buffer não for grande o suficiente para manter todas as informações solicitadas, a API retornará o máximo de dados que puder caber no buffer e a chamada falhará com HRESULT_FROM_WIN32(ERROR_MORE_DATA).
[out, optional] ReturnedLength
O número de bytes retornados no InfoBuffer.
Retornar valor
Se essa função for bem-sucedida, ela retornará S_OK. Caso contrário, ele retornará um código de erro HRESULT.
Comentários
As informações de espaço reservado incluem os seguintes atributos:
| Atributo | Descrição |
|---|---|
| OnDiskDataSize | O número total de bytes no disco. |
| ValidatedDataSize | O número total de bytes que estão sincronizados com a nuvem. |
| ModifiedDataSize | O número total de bytes que foram substituídos/acrescentados localmente, ou seja, não estão sincronizados com a nuvem. |
| PropertiesSize | O número total de bytes no disco que é usado por todos os blobs de propriedade. |
| PinState | Consulte CfSetPinState para obter mais informações. |
| InSyncState | Consulte CfSetInSyncState para obter mais informações. |
| FileId | Um número não volátil de volume largo de 64 bits que identifica exclusivamente um arquivo ou diretório. |
| SyncRootFileId | A ID do arquivo do diretório raiz de sincronização no qual reside o arquivo cujas informações de espaço reservado devem ser consultadas. |
| FileIdentity | Um blob opaco fornecido pelo provedor de sincronização para a plataforma quando o espaço reservado foi criado. A identidade do arquivo é fornecida para todos os retornos de chamada do provedor de sincronização. |
| FileIdentityLength | O comprimento da identidade do arquivo em bytes. |
Requisitos
| Requisito | Valor |
|---|---|
| Cliente mínimo com suporte | Windows 10, versão 1709 [somente aplicativos da área de trabalho] |
| Servidor mínimo com suporte | Windows Server 2016 [somente aplicativos da área de trabalho] |
| Plataforma de Destino | Windows |
| Cabeçalho | cfapi.h |
| Biblioteca | CldApi.lib |
| DLL | CldApi.dll |