Función MsiGetProductPropertyA (msi.h)

Artículo
11/20/2024

La función MsiGetProductProperty recupera las propiedades del producto. Estas propiedades se encuentran en la base de datos del producto.

Sintaxis

UINT MsiGetProductPropertyA(
  [in]      MSIHANDLE hProduct,
  [in]      LPCSTR    szProperty,
  [out]     LPSTR     lpValueBuf,
  [in, out] LPDWORD   pcchValueBuf
);

Parámetros

[in] hProduct

Controle el producto obtenido de MsiOpenProduct.

[in] szProperty

Especifica la propiedad que se va a recuperar. Esto distingue mayúsculas de minúsculas.

[out] lpValueBuf

Puntero a un búfer que recibe el valor de propiedad. El valor se trunca y termina en null si lpValueBuf es demasiado pequeño. Este parámetro puede ser NULL.

[in, out] pcchValueBuf

Puntero a una variable que especifica el tamaño, en caracteres, del búfer al que apunta el parámetro lpValueBuf. En la entrada, este es el tamaño completo del búfer, incluido 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.

Si lpValueBuf es null, pcchValueBuf puede ser null.

Valor devuelto

La función MsiGetProductProperty devuelve los valores siguientes.

Valor	Significado
ERROR_INVALID_PARAMETER	Se pasó un parámetro no válido a la función .
ERROR_INVALID_HANDLE	Se pasó un identificador no válido a la función .
ERROR_MORE_DATA	Un búfer es demasiado pequeño para contener todo el valor de propiedad.
ERROR_SUCCESS	La función se completó correctamente.

Observaciones

Cuando se devuelve la función MsiGetProductProperty, el parámetro pcchValueBuf contiene la longitud de la cadena almacenada en el búfer. El recuento devuelto no incluye el carácter nulo de terminación. Si el búfer no es lo suficientemente grande, msiGetProductProperty devuelve ERROR_MORE_DATA y msiGetProductProperty contiene el tamaño de la cadena, en caracteres, sin contar el carácter NULL.

Nota

El encabezado msi.h define MsiGetProductProperty 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 neutral de codificación con código que no es neutral de codificación puede dar lugar a errores de coincidencia que dan lugar a errores de compilación o tiempo de ejecución. Para obtener más información, vea Conventions for Function Prototypes.

Requisitos

Requisito	Valor
cliente mínimo admitido	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 Run-Time Requirements (Requisitos de Windows Installer) para obtener información sobre el Service Pack mínimo de Windows que requiere una versión de Windows Installer.
de la plataforma de destino de	Windows
encabezado de	msi.h
biblioteca de	Msi.lib
DLL de	Msi.dll

Consulte también

funciones de consulta de productos

Compartir a través de