WSPGetSockOpt
.gif "A checkmark indicates that the information in this topic is relevant for this platform, and that any API listed is also supported on this platform.")
.gif "A checkmark indicates that the information in this topic is relevant for this platform, and that any API listed is also supported on this platform.")
9/8/2008
Essa função recupera uma opção Soquete.
Syntax
int WSPGetSockOpt(
SOCKET s,
int level,
int optname,
char FAR* optval,
LPINT optlen,
LPINT lpErrno
);
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 SOL_SOCKET. A exibição opções SOL_SOCKET que são são com suporte para WSPGetSockOpt, consulte SOL_SOCKET.
- 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.
- lpErrno
[out] Um ponteiro para o código de erro.
Return Value
Se não houver erro, essa função retornará zero. Caso contrário, será retornado um valor de SOCKET_ERROR e um código de erro específico está disponível em lpErrno.
A seguinte tabela mostra os códigos de erro possível.
| Valor de erro | Descrição |
|---|---|
WSAENETDOWN |
falha no subsistema de rede. |
WSAEFAULT |
Uma da optval ou o optlen Parâmetros não é um válido parte espaço de endereço de usuário, ou a optlen parâmetro é muito pequeno. |
WSAEINVAL |
O nível é desconhecido ou inválido. |
WSAEINPROGRESS |
Função é chamada quando um callback é em andamento. |
WSAENOPROTOOPT |
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 de pacotes e OOB transferência de dados.
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 será o tamanho de um inteiro.
O cliente Windows Sockets SPI é responsável por alocando qualquer espaço memória apontado diretamente ou indiretamente por qualquer um dos parâmetros-Especifica.
Se a opção nunca foi definida com WSPSetSockOpt, em seguida, WSPGetSockOpt Retorna o valor usar como padrão para a opção.
Chamando WSPGetSockOpt Com um sem suporte opção resultará em um código de erro de WSAENOPROTOOPT sendo retornado em lpErrno.
Requirements
| Header | ws2spi.h |
| Library | Ws2.lib |
| Windows Embedded CE | Windows CE .NET 4.0 and later |
| Windows Mobile | Windows Mobile Version 5.0 and later |