The MsiEnumComponents function enumerates the installed components for all products. This function retrieves one component code each time it is called.

Syntax

C++UINT MsiEnumComponents(
  __in   DWORD iComponentIndex,
  __out  LPTSTR lpComponentBuf
);

Parameters

iComponentIndex [in]

Specifies the index of the component to retrieve. This parameter should be zero for the first call to the MsiEnumComponents function and then incremented for subsequent calls. Because components are not ordered, any new component has an arbitrary index. This means that the function can return components in any order.

lpComponentBuf [out]

Pointer to a buffer that receives the component code. This buffer must be 39 characters long. The first 38 characters are for the GUID, and the last character is for the terminating null character.

Return Value

Remarks

To enumerate components, an application should initially call the MsiEnumComponents function with the iComponentIndex parameter set to zero. The application should then increment the iComponentIndex parameter and call MsiEnumComponents until there are no more components (that is, until the function returns ERROR_NO_MORE_ITEMS).

When making multiple calls to MsiEnumComponents to enumerate all of the product's components, each call should be made from the same thread.

Requirements

See Also

System Status Functions

Send comments about this topic to Microsoft

Build date: 8/13/2009