Función MsiGetFeatureInfoA (msi.h)

La función MsiGetFeatureInfo devuelve información descriptiva para una característica.

Sintaxis

UINT MsiGetFeatureInfoA(
  [in]                MSIHANDLE hProduct,
  [in]                LPCSTR    szFeature,
  [out, optional]     LPDWORD   lpAttributes,
  [out, optional]     LPSTR     lpTitleBuf,
  [in, out, optional] LPDWORD   pcchTitleBuf,
  [out, optional]     LPSTR     lpHelpBuf,
  [in, out, optional] LPDWORD   pcchHelpBuf
);

Parámetros

[in] hProduct

Controle el producto que posee la característica. Este identificador se obtiene de MsiOpenProduct.

[in] szFeature

Código de característica de la característica sobre qué información se debe devolver.

[out, optional] lpAttributes

Puntero a una ubicación que contiene una o varias de las marcas de atributo siguientes.

INSTALLFEATUREATTRIBUTE_FAVORLOCAL (1)

INSTALLFEATUREATTRIBUTE_FAVORSOURCE (2)

INSTALLFEATUREATTRIBUTE_FOLLOWPARENT (4)

INSTALLFEATUREATTRIBUTE_FAVORADVERTISE (8)

INSTALLFEATUREATTRIBUTE_DISALLOWADVERTISE (16)

INSTALLFEATUREATTRIBUTE_NOUNSUPPORTEDADVERTISE (32)

Para obtener más información, vea
Tabla de características. Los valores devueltos por MsiGetFeatureInfo son dobles los valores de la columna Atributos de la tabla de características.

[out, optional] lpTitleBuf

Puntero a un búfer para recibir el nombre localizado de la característica, que corresponde al campo Título de la tabla de características.

Este parámetro es opcional y su valor puede ser null.

[in, out, optional] pcchTitleBuf

Como entrada, el tamaño de lpTitleBuf. Como salida, el número de caracteres devueltos en lpTitleBuf. En la entrada, este es el tamaño completo del búfer e incluye un espacio para un carácter nulo de terminación. Si el búfer que se pasa es demasiado pequeño, el recuento devuelto no incluye el carácter nulo de terminación.

[out, optional] lpHelpBuf

Puntero a un búfer para recibir la descripción localizada de la característica, que corresponde al campo Descripción de la característica de la tabla De características. Este parámetro es opcional y su valor puede ser null.

[in, out, optional] pcchHelpBuf

Como entrada, el tamaño de lpHelpBuf. Como salida, el número de caracteres devueltos en lpHelpBuf. En la entrada, este es el tamaño completo del búfer e incluye un espacio para un carácter nulo de terminación. Si el búfer pasado es demasiado pequeño, el recuento devuelto no incluye el carácter nulo de terminación.

Valor devuelto

Código devuelto	Descripción
ERROR_INVALID_HANDLE	El identificador del producto no es válido.
ERROR_INVALID_PARAMETER	Uno de los parámetros no es válido.
ERROR_MORE_DATA	Un búfer es demasiado pequeño para contener los datos solicitados.
ERROR_SUCCESS	La función devuelve correctamente.
ERROR_UNKNOWN_FEATURE	La característica no se conoce.

Comentarios

Los tamaños de búfer de la función MsiGetFeatureInfo deben incluir un carácter adicional para el carácter nulo de terminación. Si un búfer es demasiado pequeño, la cadena devuelta se trunca con null y el tamaño del búfer contiene el número de caracteres de toda la cadena, no incluido el carácter nulo de terminación. Para obtener más información, vea Llamar a funciones de base de datos desde programas.

Nota:

El encabezado msi.h define MsiGetFeatureInfo como alias que selecciona automáticamente la versión ANSI o Unicode de esta función en función de la definición de la constante de preprocesador UNICODE. La combinación del uso del alias neutro de codificación con código que no es neutral de codificación puede provocar discrepancias que dan lugar a errores de compilación o en tiempo de ejecución. Para obtener más información, vea Convenciones para prototipos de función.

Requisitos

Cliente mínimo compatible	Windows Installer 5.0 en Windows Server 2012, Windows 8, Windows Server 2008 R2 o Windows 7. Windows Installer 4.0 o Windows Installer 4.5 en Windows Server 2008 o Windows Vista. Windows Installer en Windows Server 2003 o Windows XP. Consulte Windows Installer para obtener información sobre el Service Pack mínimo de Windows que requiere una versión de Windows Installer.
Plataforma de destino	Windows
Encabezado	msi.h
Library	Msi.lib
Archivo DLL	Msi.dll

Consulte también

Funciones de consulta de productos