Función WcmQueryProperty (wcmapi.h)

La función WcmQueryProperty recupera el valor de una propiedad WCM especificada.

Sintaxis

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

Parámetros

[in, optional] pInterface

Tipo: GUID const*

Interfaz que se va a consultar. Para las propiedades globales, este parámetro es NULL.

[in, optional] strProfileName

Tipo: LPCWSTR

Nombre del perfil. Si consulta una propiedad no global (connection_cost, dataplan_status o hotspot_profile), se debe especificar el perfil o se producirá un error en la llamada.

[in] Property

Tipo: WCM_PROPERTY

Propiedad WCM que se va a consultar.

pReserved

Tipo: PVOID

Reservado.

[out] pdwDataSize

Tipo: PDWORD

Tamaño del valor de la propiedad devuelta.

[out] ppData

Tipo: PBYTE*

Valor de propiedad devuelto.

Valor devuelto

Tipo: DWORD

Devuelve ERROR_SUCCESS si se ejecuta correctamente o un valor de error de lo contrario.

Comentarios

El tipo de datos almacenados en el parámetro ppData variará, dependiendo de la propiedad que se esté consultando. En esta tabla se muestra el tipo de datos de cada propiedad.

Nombre de propiedad	Tipo de datos
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	Contiene la salida de longitud cero.

Requisitos

Cliente mínimo compatible	Windows 8 [solo aplicaciones de escritorio]
Servidor mínimo compatible	Windows Server 2012 [solo aplicaciones de escritorio]
Plataforma de destino	Windows
Encabezado	wcmapi.h
Library	Wcmapi.lib
Archivo DLL	Wcmapi.dll

Consulte también

WCM_PROPERTY