WlanHostedNetworkQueryProperty 関数 (wlanapi.h)

[アーティクル]
08/28/2023

WlanHostedNetworkQueryProperty 関数は、ワイヤレスホステッドネットワークの現在の静的プロパティに対してクエリを実行します。

構文

DWORD WlanHostedNetworkQueryProperty(
  [in]  HANDLE                     hClientHandle,
  [in]  WLAN_HOSTED_NETWORK_OPCODE OpCode,
  [out] PDWORD                     pdwDataSize,
  [out] PVOID                      *ppvData,
  [out] PWLAN_OPCODE_VALUE_TYPE    pWlanOpcodeValueType,
        PVOID                      pvReserved
);

パラメーター

[in] hClientHandle

WlanOpenHandle 関数の以前の呼び出しによって返されるクライアントのセッションハンドル。

[in] OpCode

クエリを実行するプロパティの識別子。この識別子には、Wlanapi.h ヘッダーファイルで定義されているWLAN_HOSTED_NETWORK_OPCODE列挙の値のいずれかを指定できます。

[out] pdwDataSize

WlanHostedNetworkQueryProperty 関数の呼び出しが成功した場合に、ppvData パラメーターで返されるバッファーのサイズをバイト単位で指定する値へのポインター。

[out] ppvData

入力時に、このパラメーターは NULL である必要があります。

出力時に、このパラメーターは 、WlanHostedNetworkQueryProperty 関数の呼び出しが成功した場合に、要求された静的プロパティで返されるバッファーへのポインターを受け取ります。このバッファーに関連付けられているデータ型は、 OpCode パラメーターの値によって異なります。

[out] pWlanOpcodeValueType

WlanHostedNetworkQueryProperty 関数の呼び出しが成功した場合に、ワイヤレス Hosted Network プロパティの値型を受け取る値へのポインター。返される値は、Wlanapi.h ヘッダーファイルで定義されているWLAN_OPCODE_VALUE_TYPE列挙の列挙型です。

pvReserved

将来利用するために予約されています。このパラメーターは NULL である必要があります。

戻り値

関数が成功した場合、戻り値は ERROR_SUCCESS です。

関数が失敗した場合、戻り値は次のいずれかのリターンコードになります。

リターンコード	説明
ERROR_BAD_CONFIGURATION	ワイヤレスホステッドネットワークの構成データは構成されていません。このエラーは、アプリケーションが WlanHostedNetworkQueryProperty 関数を呼び出し、 OpCode パラメーターを wlan_hosted_network_opcode_station_profile または wlan_hosted_network_opcode_connection_settings に設定した場合に、ワイヤレスホステッドネットワークで SSID が構成される前に返されます。
ERROR_INVALID_HANDLE	ハンドルが無効です。このエラーは、 hClientHandle パラメーターで指定されたハンドルがハンドルテーブルで見つからなかった場合に返されます。
ERROR_INVALID_PARAMETER	パラメーターが正しくありません。このエラーは、次のいずれかの条件が発生した場合に返されます。 hClientHandle が NULL です。 OpCode は、 WLAN_HOSTED_NETWORK_OPCODEで定義されている列挙値の 1 つではありません。 pdwDataSize は NULL です。 ppvData は NULL です。 pWlanOpcodeValueType が NULL です。 pvReserved が NULL ではありません。
ERROR_INVALID_STATE	リソースが、要求された操作を実行するための正しい状態ではありません。これは、ワイヤレスホステッドネットワークがシャットダウン中の場合に発生する可能性があります。
ERROR_OUTOFMEMORY	この操作を実行するには、使用できる領域が十分ではありません。
ERROR_SERVICE_NOT_ACTIVE	サービスは開始されていません。このエラーは、WLAN AutoConfig サービスが実行されていない場合に返されます。
その他	さまざまな RPC とその他のエラーコード。 FormatMessage を使用して、返されたエラーのメッセージ文字列を取得します。

注釈

WlanHostedNetworkQueryProperty 関数は、ワイヤレス LAN サービスがインストールされた Windows 7 および Windows Server 2008 R2 のワイヤレスホステッドネットワークをサポートするために追加されたネイティブワイヤレス API の拡張機能です。

クライアントアプリケーションは WlanHostedNetworkQueryProperty 関数を呼び出して、ワイヤレスホステッドネットワークの現在の静的プロパティに対してクエリを実行します。この機能は、ワイヤレスホステッドネットワークの状態またはプロパティを変更しません。

関数が成功した場合、 ppvData パラメーターは要求されたプロパティを含むバッファーを指します。このバッファーのサイズは、 pwdDataSize パラメーターで返されるポインターで返されます。 WLAN_OPCODE_VALUE_TYPEは、pWlanOpcodeValueType パラメーターで返されるポインターで返されます。返される ppvData パラメーターのバッファーに使用されるメモリは、バッファーが不要になった後に WlanFreeMemory 関数を呼び出すことによって解放する必要があります。

ppvData パラメーターが指すバッファーに関連付けられているデータ型は、次のように OpCode パラメーターの値によって異なります。

OpCode	説明
wlan_hosted_network_opcode_connection_settings	WLAN_HOSTED_NETWORK_CONNECTION_SETTINGS構造体へのポインターが返されます。
wlan_hosted_network_opcode_security_settings	WLAN_HOSTED_NETWORK_SECURITY_SETTINGS構造体へのポインターが返されます。
wlan_hosted_network_opcode_station_profile	ワイヤレスホステッドネットワークに接続するための XML WLAN プロファイルを含む PWSTR が返されます。
wlan_hosted_network_opcode_enable	ワイヤレスホステッドネットワークが有効になっているかどうかを示す PBOOL が返されます。

ワイヤレスホステッドネットワークで SSID が構成される前 に、WlanHostedNetworkQueryProperty 関数が OpCode パラメーターに次のいずれかの値を渡した場合、この関数は ERROR_BAD_CONFIGURATIONで失敗します。

wlan_hosted_network_opcode_station_profile
wlan_hosted_network_opcode_connection_settings

どのユーザーも WlanHostedNetworkQueryProperty 関数を呼び出して、Hosted Network プロパティに対してクエリを実行できます。

Windows 7 以降では、ホスト型ネットワーク対応ワイヤレスアダプターがコンピューターに存在する場合、オペレーティングシステムによって仮想デバイスがインストールされます。通常、この仮想デバイスは、コンピューターに 1 つのワイヤレスネットワークアダプターがある場合、"ネットワーク Connections フォルダー" に "ワイヤレスネットワーク接続 2" と表示され、デバイス名は "Microsoft Virtual WiFi ミニポートアダプター" になります。この仮想デバイスは、ソフトウェアアクセスポイント (SoftAP) 接続の実行専用に使用され、 WlanEnumInterfaces 関数によって返されるリストには存在しません。この仮想デバイスの有効期間は、物理ワイヤレスアダプターに関連付けられています。物理ワイヤレスアダプターが無効になっている場合、この仮想デバイスも削除されます。この機能は、ワイヤレス LAN サービスがインストールされている Windows Server 2008 R2 でも使用できます。

要件

要件	値
サポートされている最小のクライアント	Windows 7 [デスクトップアプリのみ]
サポートされている最小のサーバー	Windows Server 2008 R2 [デスクトップアプリのみ]
対象プラットフォーム	Windows
ヘッダー	wlanapi.h (Wlanapi.h を含む)
Library	Wlanapi.lib
[DLL]	Wlanapi.dll