Función MsiEnumProductsExA (msi.h)

La función MsiEnumProductsEx enumera a través de una o todas las instancias de productos que se anuncian o instalan actualmente en los contextos especificados. Esta función sustituye a MsiEnumProducts.

Sintaxis

UINT MsiEnumProductsExA(
  [in, optional]      LPCSTR            szProductCode,
  [in]                LPCSTR            szUserSid,
  [in]                DWORD             dwContext,
  [in]                DWORD             dwIndex,
  [out, optional]     CHAR [39]         szInstalledProductCode,
  [out, optional]     MSIINSTALLCONTEXT *pdwInstalledContext,
  [out, optional]     LPSTR             szSid,
  [in, out, optional] LPDWORD           pcchSid
);

Parámetros

[in, optional] szProductCode

Productcode GUID del producto que se va a enumerar. Solo se enumeran las instancias de productos dentro del ámbito del contexto especificado por los parámetros szUserSid y dwContext . Este parámetro se puede establecer en NULL para enumerar todos los productos del contexto especificado.

[in] szUserSid

Cadena terminada en NULL que especifica un identificador de seguridad (SID) que restringe el contexto de enumeración. La cadena de SID especial s-1-1-0 (Todos) especifica la enumeración entre todos los usuarios del sistema. Un valor de SID distinto de s-1-1-0 se considera un SID de usuario y restringe la enumeración al usuario actual o a cualquier usuario del sistema. Este parámetro se puede establecer en NULL para restringir el ámbito de enumeración al usuario actual.

[in] dwContext

Restringe la enumeración a un contexto. Este parámetro puede ser cualquiera o una combinación de los valores que se muestran en la tabla siguiente.

[in] dwIndex

Especifica el índice del producto que se va a recuperar. Este parámetro debe ser cero para la primera llamada a la función MsiEnumProductsEx y, a continuación, incrementarse para las llamadas posteriores. El índice debe incrementarse, solo si la llamada anterior ha devuelto ERROR_SUCCESS. Dado que los productos no están ordenados, ningún producto nuevo tiene un índice arbitrario. Esto significa que la función puede devolver productos en cualquier orden.

[out, optional] szInstalledProductCode

Cadena terminada en NULL de TCHAR que proporciona el GUID productCode de la instancia de producto que se enumera. Este parámetro puede ser NULL.

[out, optional] pdwInstalledContext

Devuelve el contexto de la instancia de producto que se está enumerando. El valor de salida puede ser MSIINSTALLCONTEXT_USERMANAGED, MSIINSTALLCONTEXT_USERUNMANAGED o MSIINSTALLCONTEXT_MACHINE. Este parámetro puede ser NULL.

[out, optional] szSid

Búfer de salida que recibe el SID de cadena de la cuenta en la que existe esta instancia de producto. Este búfer devuelve una cadena vacía para una instancia instalada en un contexto por máquina.

Este búfer debe ser lo suficientemente grande como para contener el SID. Si el búfer es demasiado pequeño, la función devuelve ERROR_MORE_DATA y establece *pcchSid en el número de TCHAR en el SID, no incluido el carácter NULL de terminación.

Si szSid se establece en NULL y pcchSid se establece en un puntero válido, la función devuelve ERROR_SUCCESS y establece *pcchSid en el número de TCHAR en el valor, sin incluir el valor NULL de terminación. A continuación, se puede llamar a la función de nuevo para recuperar el valor, con el búfer szSid lo suficientemente grande como para contener *pcchSid + 1 caracteres.

Si szSid y pcchSid se establecen en NULL, la función devuelve ERROR_SUCCESS si el valor existe, sin recuperar el valor.

[in, out, optional] pcchSid

Al llamar a la función , este parámetro debe ser un puntero a una variable que especifica el número de TCHAR en el búfer szSid . Cuando se devuelve la función, este parámetro se establece en el tamaño del valor solicitado, independientemente de si la función copia o no el valor en el búfer especificado. El tamaño se devuelve como el número de TCHAR en el valor solicitado, sin incluir el carácter nulo de terminación.

Este parámetro solo se puede establecer en NULL si szSid también es NULL; de lo contrario, la función devuelve ERROR_INVALID_PARAMETER.

Valor devuelto

La función MsiEnumProductsEx devuelve uno de los valores siguientes.

Comentarios

Para enumerar productos, una aplicación debe llamar inicialmente a la función MsiEnumProductsEx con el parámetro iIndex establecido en cero. A continuación, la aplicación debe incrementar el parámetro iProductIndex y llamar a MsiEnumProductsEx hasta que devuelva ERROR_NO_MORE_ITEMS y no haya más productos para enumerar.

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

Un usuario debe tener privilegios de administrador para enumerar productos en todas las cuentas de usuario o una cuenta de usuario distinta de la cuenta de usuario actual. La enumeración omite los productos que solo se anuncian (como productos no instalados) en el contexto no administrado por usuario al enumerar entre todos los usuarios o un usuario que no sea el usuario actual.

Use MsiGetProductInfoEx para obtener el estado u otra información sobre cada instancia de producto enumerada por MsiEnumProductsEx.

Requisitos

Consulte también

MsiEnumProducts

No se admite en Windows Installer 2.0 ni en versiones anteriores

ProductCode

Eliminación de revisiones