ホーム › Networking.WinSock › WSAGetQOSByName

WSAGetQOSByName

関数

名前付きテンプレートからQoS設定値を取得する。

DLLWS2_32.dll呼出規約winapiSetLastErrorあり対応OSWindows 2000 以降

シグネチャ

// WS2_32.dll
#include <windows.h>

BOOL WSAGetQOSByName(
    SOCKET s,
    WSABUF* lpQOSName,
    QOS* lpQOS
);

パラメーター

名前	型	方向	説明
s	SOCKET	in	ソケットを識別する記述子。
lpQOSName	WSABUF*	in	特定のサービス品質テンプレートへのポインター。
lpQOS	QOS*	out	格納される QOS 構造体へのポインター。

戻り値の型: BOOL

公式ドキュメント

WSAGetQOSByName 関数は、名前付きテンプレートに基づいて QOS 構造体を初期化するか、または利用可能なテンプレート名の列挙を取得するためのバッファを提供します。

戻り値

WSAGetQOSByName が成功した場合、戻り値は TRUE です。関数が失敗した場合、戻り値は FALSE です。拡張エラー情報を取得するには、 WSAGetLastError を呼び出します。

エラーコード	意味
WSANOTINITIALISED	この関数を使用する前に、 WSAStartup の呼び出しが成功している必要があります。
WSAENETDOWN	ネットワークサブシステムに障害が発生しました。
WSAENOTSOCK	記述子がソケットではありません。
WSAEFAULT	lpQOSName または lpQOS パラメーターがユーザーアドレス空間の有効な部分ではないか、あるいは lpQOS のバッファ長が小さすぎます。

解説(Remarks)

WSAGetQOSByName 関数は、特定のサービスクラスやメディアタイプに適した既知の値のセットで QOS 構造体を初期化するために、アプリケーションによって使用されます。これらの値は、よく知られた名前によって参照されるテンプレートに格納されています。クライアントは、lpQOSName が指す WSABUF 構造体の buf パラメーターに、テンプレート名を指定する長さがゼロでない文字列へのポインターを設定することで、これらの値を取得できます。この場合、lpQOSName の用途は入力のみであり、結果は lpQOS を通じて返されます。

あるいは、クライアントはこの関数を使用して、利用可能なテンプレート名の列挙を取得することもできます。クライアントは、lpQOSName が指す WSABUF の buf パラメーターに長さゼロの null 終端文字列を設定することで、これを行えます。この場合、buf が指すバッファは、lpQOSName が指す WSABUF の len パラメーターで示される buf 内の利用可能なバイト数に達するまで、利用可能な null 終端のテンプレート名の並びで上書きされます。名前のリスト自体は、長さゼロの名前で終端されます。 WSAGetQOSByName 関数がテンプレート名の取得に使用される場合、lpQOS パラメーターは無視されます。

出典・ライセンス: 上記「公式ドキュメント」の内容は Microsoft の Win32 API ドキュメント(MicrosoftDocs/sdk-api)を日本語に翻訳・改変したものです。© Microsoft Corporation. CC BY 4.0 で提供。
Microsoft 公式リファレンス: 英語 (en-us) · 日本語 (ja-jp) · 原文ソース (GitHub)

各言語での呼び出し定義

// WS2_32.dll
#include <windows.h>

BOOL WSAGetQOSByName(
    SOCKET s,
    WSABUF* lpQOSName,
    QOS* lpQOS
);

[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("WS2_32.dll", SetLastError = true, ExactSpelling = true)]
static extern bool WSAGetQOSByName(
    UIntPtr s,   // SOCKET
    IntPtr lpQOSName,   // WSABUF*
    IntPtr lpQOS   // QOS* out
);

<DllImport("WS2_32.dll", SetLastError:=True, ExactSpelling:=True)>
Public Shared Function WSAGetQOSByName(
    s As UIntPtr,   ' SOCKET
    lpQOSName As IntPtr,   ' WSABUF*
    lpQOS As IntPtr   ' QOS* out
) As <MarshalAs(UnmanagedType.Bool)> Boolean
End Function

' s : SOCKET
' lpQOSName : WSABUF*
' lpQOS : QOS* out
Declare PtrSafe Function WSAGetQOSByName Lib "ws2_32" ( _
    ByVal s As LongPtr, _
    ByVal lpQOSName As LongPtr, _
    ByVal lpQOS As LongPtr) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。

import ctypes
from ctypes import wintypes

WSAGetQOSByName = ctypes.windll.ws2_32.WSAGetQOSByName
WSAGetQOSByName.restype = wintypes.BOOL
WSAGetQOSByName.argtypes = [
    ctypes.c_size_t,  # s : SOCKET
    ctypes.c_void_p,  # lpQOSName : WSABUF*
    ctypes.c_void_p,  # lpQOS : QOS* out
]
# GetLastError: use ctypes.GetLastError() (or ctypes.WinDLL(use_last_error=True))

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('WS2_32.dll')
WSAGetQOSByName = Fiddle::Function.new(
  lib['WSAGetQOSByName'],
  [
    Fiddle::TYPE_UINTPTR_T,  # s : SOCKET
    Fiddle::TYPE_VOIDP,  # lpQOSName : WSABUF*
    Fiddle::TYPE_VOIDP,  # lpQOS : QOS* out
  ],
  Fiddle::TYPE_INT)

#[link(name = "ws2_32")]
extern "system" {
    fn WSAGetQOSByName(
        s: usize,  // SOCKET
        lpQOSName: *mut WSABUF,  // WSABUF*
        lpQOS: *mut QOS  // QOS* out
    ) -> i32;
}
// crates: windows-sys provides ready-made bindings for this API.

$sig = @"
[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("WS2_32.dll", SetLastError = true)]
public static extern bool WSAGetQOSByName(UIntPtr s, IntPtr lpQOSName, IntPtr lpQOS);
"@
$api = Add-Type -MemberDefinition $sig -Name 'WS2_32_WSAGetQOSByName' -Namespace Win32 -PassThru
# $api::WSAGetQOSByName(s, lpQOSName, lpQOS)

#uselib "WS2_32.dll"
#func global WSAGetQOSByName "WSAGetQOSByName" sptr, sptr, sptr
; WSAGetQOSByName s, varptr(lpQOSName), varptr(lpQOS)   ; 戻り値は stat
; s : SOCKET -> "sptr"
; lpQOSName : WSABUF* -> "sptr"
; lpQOS : QOS* out -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。

出力引数:

#uselib "WS2_32.dll"
#cfunc global WSAGetQOSByName "WSAGetQOSByName" sptr, var, var
; res = WSAGetQOSByName(s, lpQOSName, lpQOS)
; s : SOCKET -> "sptr"
; lpQOSName : WSABUF* -> "var"
; lpQOS : QOS* out -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。#uselib "WS2_32.dll"
#cfunc global WSAGetQOSByName "WSAGetQOSByName" sptr, sptr, sptr
; res = WSAGetQOSByName(s, varptr(lpQOSName), varptr(lpQOS))
; s : SOCKET -> "sptr"
; lpQOSName : WSABUF* -> "sptr"
; lpQOS : QOS* out -> "sptr"
; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは varptr(変数))。