Função WSAGetQOSByName (winsock2.h)

Artigo
03/04/2024

A função WSAGetQOSByName inicializa uma estrutura QOS com base em um modelo nomeado ou fornece um buffer para recuperar uma enumeração dos nomes de modelo disponíveis.

Sintaxe

BOOL WSAAPI WSAGetQOSByName(
  [in]      SOCKET   s,
  [in, out] LPWSABUF lpQOSName,
  [out]     LPQOS    lpQOS
);

Parâmetros

[in] s

Um descritor que identifica um soquete.

[in, out] lpQOSName

Um ponteiro para um modelo de qualidade de serviço específico.

[out] lpQOS

Um ponteiro para a estrutura QOS a ser preenchida.

Retornar valor

Se WSAGetQOSByName for bem-sucedido, o valor retornado será TRUE. Se a função falhar, o valor retornado será FALSE. Para obter informações de erro estendidas, chame WSAGetLastError.

Código do erro	Significado
WSANOTINITIALISED	Uma chamada WSAStartup bem-sucedida deve ocorrer antes de usar essa função.
WSAENETDOWN	O subsistema de rede falhou.
WSAENOTSOCK	O descritor não é um soquete.
WSAEFAULT	O parâmetro lpQOSName ou lpQOS não é uma parte válida do espaço de endereço do usuário ou o comprimento do buffer para lpQOS é muito pequeno.

Comentários

A função WSAGetQOSByName é usada por aplicativos para inicializar uma estrutura QOS para um conjunto de valores conhecidos apropriados para uma classe de serviço ou tipo de mídia específico. Esses valores são armazenados em um modelo referenciado por um nome conhecido. O cliente pode recuperar esses valores definindo o parâmetro buf da estrutura WSABUF indicada por lpQOSName, que aponta para uma cadeia de caracteres de comprimento diferente de zero especificando um nome de modelo. Nesse caso, o uso de lpQOSName é apenas IN e os resultados são retornados por meio do lpQOS.

Como alternativa, o cliente pode usar essa função para recuperar uma enumeração de nomes de modelo disponíveis. O cliente pode fazer isso definindo o parâmetro buf do WSABUF indicado por lpQOSName como uma cadeia de caracteres terminada em nulo de comprimento zero. Nesse caso, o buffer indicado por buf é substituído por uma sequência de tantos nomes de modelo disponíveis e terminados em nulo até o número de bytes disponíveis no buf , conforme indicado pelo parâmetro len do WSABUF indicado por lpQOSName. A lista de nomes em si é encerrada por um nome de comprimento zero. Quando a função WSAGetQOSByName é usada para recuperar nomes de modelo, o parâmetro lpQOS é ignorado.

Requisitos

Requisito	Valor
Cliente mínimo com suporte	Windows 2000 Professional [somente aplicativos da área de trabalho]
Servidor mínimo com suporte	Windows 2000 Server [somente aplicativos da área de trabalho]
Plataforma de Destino	Windows
Cabeçalho	winsock2.h
Biblioteca	Ws2_32.lib
DLL	Ws2_32.dll