Função CfGetSyncRootInfoByHandle (cfapi.h)

Obtém várias características da raiz de sincronização que contém um determinado arquivo especificado por um identificador de arquivo.

Sintaxe

HRESULT CfGetSyncRootInfoByHandle(
  [in]            HANDLE                  FileHandle,
  [in]            CF_SYNC_ROOT_INFO_CLASS InfoClass,
  [out]           PVOID                   InfoBuffer,
  [in]            DWORD                   InfoBufferLength,
  [out, optional] DWORD                   *ReturnedLength
);

Parâmetros

[in] FileHandle

Identificador do arquivo na raiz de sincronização cujas informações devem ser consultadas.

[in] InfoClass

Tipos de informações raiz de sincronização.

[out] InfoBuffer

Um ponteiro para um buffer que receberá as informações raiz de sincronização.

[in] InfoBufferLength

Comprimento, em bytes, do InfoBuffer.

[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

Ao contrário da maioria das APIs de espaço reservado que tomam um identificador de arquivo, essa não modifica o arquivo de forma alguma, portanto, o FileHandle requer apenas READ_ATTRIBUTES acesso.

Se o arquivo não estiver sob uma raiz de sincronização de arquivos de nuvem, a API falhará. Em caso de êxito, as informações são retornadas de acordo com o InfoClass específico solicitado.

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

Confira também

CfGetSyncRootInfoByPath