getsockopt (Windows Sockets)

9/8/2008

Essa função recupera uma opção Soquete.

Syntax

int getsockopt(
  SOCKET s,
  int level,
  int optname,
  char FAR* optval,
  int FAR* optlen
);

Parameters

• s
  [no] Descritor identificando um Soquete.

• nível
  [no] Nível no qual a opção está definida; o com suporte os níveis incluem:

  For All Platforms:

  • IPPROTO_IP
  • IPPROTO_IPV6
  • IPPROTO_TCP
  • IPPROTO_UDP
  • SOL_SOCKET
  • SOL_IRLMP
  • IP_DSCP_TRAFFIC_TYPE
  • For Windows Mobile:
  • IPPROTO_RAW

• OptName
  [no] Opção Soquete para que o valor é ser recuperado.

• optval
  [out] Ponteiro para a reserva em que o valor para a opção solicitada está a ser retornado.

• optlen
  [in, Out] Ponteiro para o tamanho das optval reserva.

Return Value

Se não houver erro, essa função retornará zero. Se um erro ocorrer, será retornado um valor de SOCKET_ERROR, e um código de erro específicos podem ser recuperadas por chamado WSAGetLastError.

A seguinte tabela mostra os códigos de erro possível.

Código de erro	Descrição
WSANOTINITIALISED	Um bem-sucedido chamar WSAStartup deve ocorrer antes de usar essa função.
WSAENETDOWN	Falha no subsistema da rede.
WSAEFAULT	Uma da optval Ou optlen Parâmetros não é um válido parte espaço de endereço de usuário, ou a optlen parâmetro é muito pequeno.
WSAEINPROGRESS	Um bloqueio é chamar sockets do Windows (Winsock) em andamento, ou o serviço provedor ainda é processamento um função callback.
WSAEINVAL	O nível parâmetro é desconhecido ou inválido.
WSAENOPROTOOPT	A opção é desconhecida ou sem suporte por família a protocolo indicado.
WSAENOTSOCK	O descritor não é um Soquete.

Remarks

Essa função recupera o atual valor para uma opção Soquete associado com um Soquete de qualquer tipo, em qualquer estado e armazena o resultado na optval. As opções podem existir no múltiplo níveis protocolo, mas elas sempre estão presentes na primeira Soquete nível. Opções afetam operações Soquete, such as o roteamento pacote e out of transferência de dados banda (OOB).

O valor associado com a opção selecionada é retornado na reserva optval. O inteiro apontado pelo optlen Originalmente deve conter o tamanho desta reserva; Em retorno, ele será definido para o tamanho do valor retornado. Para SO_LINGER, esse será o tamanho de uma estrutura linger. Para a maioria das outras opções, ele será o tamanho de um inteiro.

O aplicativo é responsável por alocando qualquer espaço memória apontado diretamente ou indiretamente por qualquer um dos parâmetros-especificado.

Se a opção nunca foi definida com setsockopt (Windows Sockets), em seguida, getsockopt Retorna o valor usar como padrão para a opção.

A exibição opções SOL_SOCKET que são são com suporte para getsockopt, consulte SOL_SOCKET.

A exibição opções IPPROTO_TCP que são são com suporte para getsockopt, consulte IPPROTO_TCP.

A exibição opções IPPROTO_IP que são são com suporte para getsockopt, consulte IPPROTO_IP.

A exibição IPPROTO_IPv6 opções que são são com suporte para getsockopt, consulte IPPROTO_IPV6.

A exibição opções IPPROTO_RAW que são são com suporte para getsockopt, consulte Windows Mobile tópico IPPROTO_RAW.

A exibição opções SOL_IRLMP que são são com suporte para getsockopt, consulte SOL_IRLMP.

Observação

Windows Embedded CE não suporte Internetwork Packet Exchange (IPX).

A seguinte lista mostra opções BSD que não estão com suporte em Windows Embedded CE para getsockopt

• SO_RCVLOWAT
• SO_RCVTIME
• SO_SNDLOWAT
• SO_SNDTIMEO
• TCP_MAXSEG

Chamando getsockopt Com um sem suporte opção resultará em um código de erro de WSAENOPROTOOPT que está sendo retornado da WSAGetLastError.

Anotações de Sockets IrDA

• O arquivo cabeçalho Af_irda.h deve ser explicitamente incluído.
• Windows NT® e Windows 2000 retornará WSAENETDOWN para indicar o subjacente transceptor driver falha ao inicializar com a pilha protocolo IrDA.
• IrDA oferece suporte às opções especiais Soquete. Para obter mais informações sobre essas opções Soquete, consulte SOL_IRLMP.
• Muitos SO nível Soquete opções não estão significativo para IrDA; Somente SO_LINGER e SO_DONTLINGER são especificamente com suporte.

Para obter mais inforamtion sobre suporte IrDA no Windows Embedded CE, consulte Infrared Communications.

Requirements

Header	winsock2.h
Library	Ws2.lib
Windows Embedded CE	Windows CE 1.0 and later
Windows Mobile	Windows Mobile Version 5.0 and later

See Also

Reference

bind (Windows Sockets)
closesocket
setsockopt (Windows Sockets)
socket (Windows Sockets)
WSAConnect
WSAEnumProtocols
WSAGetLastError
WSASetLastError
WSAStartup
linger

Other Resources

SOCKADDR_IRDA