Función MsiEnumRelatedProductsW (msi.h)

La función MsiEnumRelatedProducts enumera los productos con un código de actualización especificado. Esta función enumera los productos actualmente instalados y anunciados que tienen la propiedad UpgradeCode especificada en su tabla Property.

Sintaxis

UINT MsiEnumRelatedProductsW(
  [in]  LPCWSTR lpUpgradeCode,
  [in]  DWORD   dwReserved,
  [in]  DWORD   iProductIndex,
  [out] LPWSTR  lpProductBuf
);

Parámetros

[in] lpUpgradeCode

Cadena terminada en null que especifica el código de actualización de los productos relacionados que el instalador va a enumerar.

[in] dwReserved

Este parámetro está reservado y debe ser 0.

[in] iProductIndex

Índice de base cero en los productos registrados.

[out] lpProductBuf

Búfer para recibir el GUID del código de producto. Este búfer debe tener 39 caracteres. Los primeros 38 caracteres son para el GUID y el último carácter es para el carácter nulo de terminación.

Valor devuelto

Valor	Significado
ERROR_BAD_CONFIGURATION	Los datos de configuración están dañados.
ERROR_INVALID_PARAMETER	Se pasó un parámetro no válido a la función.
ERROR_NO_MORE_ITEMS	No hay ningún producto que devolver.
ERROR_NOT_ENOUGH_MEMORY	El sistema no tiene suficiente memoria para completar la operación. Disponible a partir de Windows Server 2003.
ERROR_SUCCESS	Se ha enumerado un valor.

Comentarios

Consulte la propiedad UpgradeCode .

Para enumerar los productos instalados y anunciados actualmente que tienen un código de actualización específico, una aplicación debe llamar inicialmente a la función MsiEnumRelatedProducts con el parámetro iProductIndex establecido en cero. A continuación, la aplicación debe incrementar el parámetro iProductIndex y llamar a MsiEnumRelatedProducts hasta que la función devuelva ERROR_NO_MORE_ITEMS, lo que significa que no hay más productos con el código de actualización especificado.

Al realizar varias llamadas a MsiEnumRelatedProducts para enumerar todos los productos relacionados, cada llamada debe realizarse desde el mismo subproceso.

Nota

El encabezado msi.h define MsiEnumRelatedProducts 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

Requisito	Value
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