Función VariantToBooleanWithDefault (propvarutil.h)
Extrae un valor BOOL de una estructura VARIANT . Si no existe ningún valor, se devuelve el valor predeterminado especificado.
Sintaxis
PSSTDAPI_(BOOL) VariantToBooleanWithDefault(
[in] REFVARIANT varIn,
[in] BOOL fDefault
);
Parámetros
[in] varIn
Tipo: REFVARIANT
Referencia a una estructura VARIANT de origen.
[in] fDefault
Tipo: BOOL
Valor predeterminado para su uso en el que no existe ningún valor extractable.
Valor devuelto
Tipo: BOOL
Devuelve el valor BOOL extraído; de lo contrario, el valor predeterminado especificado en fDefault.
Comentarios
Esta función auxiliar se usa cuando la aplicación que realiza la llamada espera que variant contenga un valor BOOL y quiera usar un valor predeterminado si no lo hace.
Si el valor VARIANT de origen es de tipo VT_BOOL, este asistente extrae el valor BOOL .
Si el valor VARIANT de origen no es de tipo VT_BOOL, la función intenta convertir el valor en VARIANT en un BOOL.
Si variant de origen es de tipo VT_EMPTY o una conversión no es posible, VariantToBooleanWithDefault devuelve el valor predeterminado proporcionado por fDefault. Consulte PropVariantChangeType para obtener una lista de las posibles conversiones.
Ejemplos
En el ejemplo siguiente, para incluirse como parte de un programa mayor, se muestra cómo usar VariantToBooleanWithDefault para tener acceso a un valor BOOL almacenado en una estructura VARIANT .
// VARIANT var;
// Assume variable var is initialized and valid.
// The application expects var to hold a BOOL value.
// The application treats VT_EMPTY as FALSE.
BOOL fValue = VariantToBooleanWithDefault(var, FALSE);
// fValue is now valid.
Requisitos
| Requisito | Value |
|---|---|
| Cliente mínimo compatible | Windows XP con SP2, Windows Vista [solo aplicaciones de escritorio] |
| Servidor mínimo compatible | Windows Server 2003 con SP1 [solo aplicaciones de escritorio] |
| Plataforma de destino | Windows |
| Encabezado | propvarutil.h |
| Library | Propsys.lib |
| Archivo DLL | Propsys.dll (versión 6.0 o posterior) |
| Redistribuible | Búsqueda de escritorio de Windows (WDS) 3.0 |