Função WinHttpGetDefaultProxyConfiguration (winhttp.h)

  • Artigo

A função WinHttpGetDefaultProxyConfiguration recupera a configuração de proxy WinHTTP padrão do registro.

Sintaxe

WINHTTPAPI BOOL WinHttpGetDefaultProxyConfiguration(
  [in, out] WINHTTP_PROXY_INFO *pProxyInfo
);

Parâmetros

[in, out] pProxyInfo

Um ponteiro para uma variável do tipo WINHTTP_PROXY_INFO que recebe a configuração de proxy padrão.

Retornar valor

Retornará TRUE se tiver êxito ou FALSE caso contrário. Para recuperar uma mensagem de erro específica, chame GetLastError. Os códigos de erro retornados incluem o seguinte.

Código do Erro Descrição
ERROR_WINHTTP_INTERNAL_ERROR
 Ocorreu um erro interno.
ERROR_NOT_ENOUGH_MEMORY
 Não havia memória suficiente disponível para concluir a operação solicitada. (Código de erro do Windows)

Comentários

WinHttpGetDefaultProxyConfiguration recupera a configuração de proxy definida por WinHttpSetDefaultProxyConfiguration ou ProxyCfg.exe.

A configuração de proxy padrão pode ser substituída para uma sessão WinHTTP chamando WinHttpSetOption e especificando o sinalizador WINHTTP_OPTION_PROXY .
WinHttpGetDefaultProxyConfiguration não recupera a configuração da sessão atual. Ele recupera a configuração especificada no registro.

Se o registro contiver uma lista de servidores proxy, o membro dwAccessType do pProxyInfo será definido como WINHTTP_ACCESS_TYPE_NAMED_PROXY. Caso contrário, ele será definido como WINHTTP_ACCESS_TYPE_NO_PROXY.

WinHttpGetDefaultProxyConfiguration aloca memória para os membros da cadeia de caracteres do pProxyInfo. Para liberar essa memória, chame GlobalFree.

Mesmo quando WinHTTP é usado no modo assíncrono (ou seja, quando WINHTTP_FLAG_ASYNC foi definido no WinHttpOpen), essa função opera de forma síncrona. O valor retornado indica êxito ou falha. Para obter informações de erro estendidas, chame GetLastError.

Nota Para Windows XP e Windows 2000, consulte a seção Requisitos de tempo de execução da Página Inicial do WinHTTP.
 

Exemplos

O exemplo de código a seguir mostra como recuperar a configuração de proxy padrão do registro.

    WINHTTP_PROXY_INFO proxyInfo;

    // Retrieve the default proxy configuration.
    WinHttpGetDefaultProxyConfiguration( &proxyInfo );

    // Display the proxy servers and free memory 
    // allocated to this string.
    if (proxyInfo.lpszProxy != NULL)
    {
        printf("Proxy server list: %S\n", proxyInfo.lpszProxy);
        GlobalFree( proxyInfo.lpszProxy );
    }

    // Display the bypass list and free memory 
    // allocated to this string.
    if (proxyInfo.lpszProxyBypass != NULL)
    {
        printf("Proxy bypass list: %S\n", proxyInfo.lpszProxyBypass);
        GlobalFree( proxyInfo.lpszProxyBypass );
    }

Requisitos

Requisito Valor
Cliente mínimo com suporte Windows XP, Windows 2000 Professional com SP3 [somente aplicativos da área de trabalho]
Servidor mínimo com suporte Windows Server 2003, Windows 2000 Server com SP3 [somente aplicativos da área de trabalho]
Plataforma de Destino Windows
Cabeçalho winhttp.h
Biblioteca Winhttp.lib
DLL Winhttp.dll
Redistribuível WinHTTP 5.0 e Internet Explorer 5.01 ou posterior no Windows XP e Windows 2000.

Confira também

ProxyCfg.exe, uma ferramenta de configuração de proxy

Versões do WinHTTP

WinHttpSetDefaultProxyConfiguration