WcmQueryProperty 関数 (wcmapi.h)

WcmQueryProperty 関数は、指定された WCM プロパティの値を取得します。

構文

DWORD WcmQueryProperty(
  [in, optional] const GUID   *pInterface,
  [in, optional] LPCWSTR      strProfileName,
  [in]           WCM_PROPERTY Property,
                 void         *pReserved,
  [out]          PDWORD       pdwDataSize,
  [out]          PBYTE        *ppData
);

パラメーター

[in, optional] pInterface

型: const GUID*

クエリを実行するインターフェイス。 グローバル プロパティの場合、このパラメーターは NULL です。

[in, optional] strProfileName

種類: LPCWSTR

プロファイルの名前。 グローバル以外のプロパティ (connection_cost、dataplan_status、またはhotspot_profile) に対してクエリを実行する場合は、プロファイルを指定する必要があります。または、呼び出しは失敗します。

[in] Property

種類: WCM_PROPERTY

クエリを実行する WCM プロパティ。

pReserved

種類: PVOID

予約済み。

[out] pdwDataSize

型: PDWORD

返されるプロパティ値のサイズ。

[out] ppData

種類: PBYTE*

返されるプロパティ値。

戻り値

型: DWORD

成功した場合はERROR_SUCCESSを返し、それ以外の場合はエラー値を返します。

解説

ppData パラメーターに格納されているデータの種類は、クエリ対象のプロパティによって異なります。 次の表は、各プロパティのデータ型を示しています。

プロパティ名	データ型
wcm_global_property_domain_policy	WCM_POLICY_VALUE
wcm_global_property_minimize_policy	WCM_POLICY_VALUE
wcm_global_property_roaming_policy	WCM_POLICY_VALUE
wcm_global_property_powermanagement_policy	WCM_POLICY_VALUE
wcm_intf_property_connection_cost	WCM_CONNECTION_COST_DATA
wcm_intf_property_dataplan_status	WCM_DATAPLAN_STATUS
wcm_intf_property_hotspot_profile	長さ 0 の出力が含まれます。

要件

サポートされている最小のクライアント	Windows 8 [デスクトップ アプリのみ]
サポートされている最小のサーバー	Windows Server 2012 [デスクトップ アプリのみ]
対象プラットフォーム	Windows
ヘッダー	wcmapi.h
Library	Wcmapi.lib
[DLL]	Wcmapi.dll

関連項目

WCM_PROPERTY