Função GetUrlCacheEntryInfoA (wininet.h)

Recupera informações sobre uma entrada de cache.

Sintaxe

BOOL GetUrlCacheEntryInfoA(
  [in]      LPCSTR                       lpszUrlName,
  [out]     LPINTERNET_CACHE_ENTRY_INFOA lpCacheEntryInfo,
  [in, out] LPDWORD                      lpcbCacheEntryInfo
);

Parâmetros

[in] lpszUrlName

Um ponteiro para uma cadeia de caracteres terminada em nulo que contém o nome da entrada de cache. A cadeia de caracteres de nome não deve conter nenhum caractere de escape.

[out] lpCacheEntryInfo

Um ponteiro para uma estrutura de INTERNET_CACHE_ENTRY_INFO que recebe informações sobre a entrada de cache. Um buffer deve ser alocado para esse parâmetro.

Como o tamanho necessário do buffer não é conhecido com antecedência, é melhor alocar um buffer adequado para lidar com o tamanho da maioria das entradas INTERNET_CACHE_ENTRY_INFO. Não há nenhum limite de tamanho de entrada de cache, portanto, os aplicativos que precisam enumerar o cache devem estar preparados para alocar buffers de tamanho variável.

[in, out] lpcbCacheEntryInfo

Um ponteiro para uma variável que especifica o tamanho do buffer lpCacheEntryInfo , em bytes. Quando a função retorna, a variável contém o número de bytes copiados para o buffer ou o tamanho necessário do buffer, em bytes.

Valor de retorno

Retorna TRUE se tiver êxito ou false caso contrário. Para obter informações de erro estendidas, chame GetLastError. Os valores de erro possíveis incluem o seguinte.

Código de retorno	Descrição
ERROR_FILE_NOT_FOUND	A entrada de cache especificada não é encontrada no cache.
ERROR_INSUFFICIENT_BUFFER	O tamanho de lpCacheEntryInfo conforme especificado por lpdwCacheEntryInfoBufferSize não é suficiente para conter todas as informações. O valor retornado em lpdwCacheEntryInfoBufferSize indica o tamanho do buffer necessário para conter todas as informações.

Observações

GetUrlCacheEntryInfo não faz nenhuma análise de URL, portanto, uma URL que contém uma âncora (#) não será encontrada no cache, mesmo se o recurso for armazenado em cache. Por exemplo, se a URL http://example.com/example.htm#sample for passada, a função retornará ERROR_FILE_NOT_FOUND mesmo que http://example.com/example.htm esteja no cache.

Assim como todos os outros aspectos da API WinINet, essa função não pode ser chamada com segurança de dentro do DllMain ou dos construtores e destruidores de objetos globais.

Observação WinINet não dá suporte a implementações de servidor. Além disso, ele não deve ser usado de um serviço. Para implementações ou serviços de servidor, use do Microsoft Windows HTTP Services (WinHTTP).

 

Nota

O cabeçalho wininet.h define GetUrlCacheEntryInfo como um alias que seleciona automaticamente a versão ANSI ou Unicode dessa função com base na definição da constante do pré-processador UNICODE. A combinação do uso do alias neutro de codificação com código que não é neutro em codificação pode levar a incompatibilidades que resultam em erros de compilação ou de runtime. Para obter mais informações, consulte Conventions for Function Prototypes.

Requisitos

Requisito	Valor
de cliente com suporte mínimo	Windows 2000 Professional [somente aplicativos da área de trabalho]
servidor com suporte mínimo	Windows 2000 Server [somente aplicativos da área de trabalho]
da Plataforma de Destino	Windows
cabeçalho	wininet.h
biblioteca	Wininet.lib
de DLL	Wininet.dll

Consulte também

cache

Funções WinINet