Função SHIsFileAvailableOffline (shellapi.h)

  • Artigo

Determina se um arquivo ou pasta está disponível para uso offline. Essa função também determina se o arquivo seria aberto da rede, do cache local de Arquivos Offline ou de ambos os locais.

Sintaxe

SHSTDAPI SHIsFileAvailableOffline(
  [in]            PCWSTR pwszPath,
  [out, optional] DWORD  *pdwStatus
);

Parâmetros

[in] pwszPath

Tipo: PCWSTR

Um ponteiro para um valor de cadeia de caracteres que especifica o caminho completo para um arquivo ou diretório de rede. Esse caminho não precisa estar no formato UNC. Se pszPath não for um caminho de rede, a função retornará E_INVALIDARG.

[out, optional] pdwStatus

Tipo: LPDWORD

Um ponteiro para uma variável do tipo DWORD que recebe um ou mais dos sinalizadores a seguir se a função for bem-sucedida.

OFFLINE_STATUS_LOCAL (0x01)

Se o arquivo estiver aberto, ele estará aberto no cache.

OFFLINE_STATUS_REMOTE (0x02)

Se o arquivo estiver aberto, ele estará aberto no servidor.

OFFLINE_STATUS_INCOMPLETE (0x04)

No momento, a cópia local está incompleta. O arquivo não pode ser aberto no modo offline até que tenha sido sincronizado.

Retornar valor

Tipo: HRESULT

Essa função pode retornar um desses valores.

Código de retorno Descrição
S_OK
 O arquivo ou diretório é armazenado em cache. Ele está disponível offline, a menos que OFFLINE_STATUS_INCOMPLETE esteja definido.
E_INVALIDARG
 O caminho é inválido ou não é um caminho de rede. O arquivo ou diretório não é armazenado em cache.
E_FAIL
 O arquivo ou diretório não é armazenado em cache.

Comentários

Se pszPath for um diretório, SHIsFileAvailableOffline não retornará o sinalizador OFFLINE_STATUS_INCOMPLETE .

Se SHIsFileAvailableOffline retornar OFFLINE_STATUS_LOCAL e OFFLINE_STATUS_REMOTE, o arquivo ou diretório será aberto em ambos os locais. Isso é comum quando o servidor está online.

Requisitos

Requisito Valor
Cliente mínimo com suporte Windows 2000 Professional [somente aplicativos da área de trabalho]
Servidor mínimo com suporte Windows 2000 Server [somente aplicativos da área de trabalho]
Plataforma de Destino Windows
Cabeçalho shellapi.h
Biblioteca Shell32.lib
DLL Shell32.dll (versão 5.0 ou posterior)