Função CreateUrlCacheEntryA (wininet.h)

Artigo
11/20/2024

Cria um nome de arquivo local para salvar a entrada de cache com base na URL especificada e na extensão do nome do arquivo.

Sintaxe

BOOL CreateUrlCacheEntryA(
  [in]  LPCSTR lpszUrlName,
  [in]  DWORD  dwExpectedFileSize,
  [in]  LPCSTR lpszFileExtension,
  [out] LPSTR  lpszFileName,
  [in]  DWORD  dwReserved
);

Parâmetros

[in] lpszUrlName

Ponteiro para um valor de cadeia de caracteres que contém o nome da URL. A cadeia de caracteres deve conter um valor; uma cadeia de caracteres vazia fará com que CreateUrlCacheEntry falhe. Além disso, a cadeia de caracteres não deve conter nenhum caractere de escape.

[in] dwExpectedFileSize

Tamanho esperado do arquivo necessário para armazenar os dados que correspondem à entidade de origem, em TCHARs. Se o tamanho esperado for desconhecido, defina esse valor como zero.

[in] lpszFileExtension

Ponteiro para um valor de cadeia de caracteres que contém um nome de extensão do arquivo no armazenamento local.

[out] lpszFileName

Ponteiro para um buffer que recebe o nome do arquivo. O buffer deve ser grande o suficiente para armazenar o caminho do arquivo criado (pelo menos MAX_PATH caracteres de comprimento).

[in] dwReserved

Esse parâmetro é reservado e deve ser 0.

Valor de retorno

Se a função for bem-sucedida, a função retornará VERDADEIRO.

Se a função falhar, ela retornará FALSE . Para obter informações de erro estendidas, chame GetLastError.

Observações

Depois que CreateUrlCacheEntry for chamado, o aplicativo poderá gravar diretamente no arquivo no armazenamento local. Quando o arquivo é completamente recebido, o chamador deve chamar CommitUrlCacheEntry para confirmar a entrada no cache.

WinINet tenta decodificar parâmetros Unicode de acordo com a página de código do sistema. Os aplicativos devem garantir que os parâmetros Unicode sejam codificados corretamente para a página de código do sistema. Os aplicativos podem definir a página de código do sistema com InternetSetOption, conforme mostrado no exemplo de código a seguir:

DWORD CP_SHIFT_JIS = 932;  // ANSI/OEM  Japanese, Shift-JIS
InternetSetOption( hRequest,
                   INTERNET_OPTION_CODEPAGE,
                   &CP_SHIFT_JIS,
                   sizeof(DWORD) );

Se o parâmetro Unicode não estiver codificado corretamente na página de código do sistema, WinINet tentará decodificar UTF8.

Quando os itens são recuperados do cache, a página de código do sistema usada para colocar o item no cache deve corresponder à página de código do sistema atual para o usuário. Para aplicativos em execução no IE6 e anteriores, se a decodificação da página de código do sistema falhar, WinINet tentará decodificar UTF8.

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 CreateUrlCacheEntry 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

commitUrlCacheEntry

Funções WinINet

Compartilhar via