MsiGetFeatureInfoA-Funktion (msi.h)

  • Artikel

Die MsiGetFeatureInfo-Funktion gibt beschreibende Informationen für ein Feature zurück.

Syntax

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
);

Parameter

[in] hProduct

Handle mit dem Produkt, das das Feature besitzt. Dieses Handle wird von MsiOpenProduct abgerufen.

[in] szFeature

Featurecode für das Feature, welche Informationen zurückgegeben werden sollen.

[out, optional] lpAttributes

Zeiger auf einen Speicherort, der mindestens eines der folgenden Attributflags enthält.

INSTALLFEATUREATTRIBUTE_FAVORLOCAL (1)

INSTALLFEATUREATTRIBUTE_FAVORSOURCE (2)

INSTALLFEATUREATTRIBUTE_FOLLOWPARENT (4)

INSTALLFEATUREATTRIBUTE_FAVORADVERTISE (8)

INSTALLFEATUREATTRIBUTE_DISALLOWADVERTISE (16)

INSTALLFEATUREATTRIBUTE_NOUNSUPPORTEDADVERTISE (32)

Weitere Informationen finden Sie unter
Featuretabelle. Die Von MsiGetFeatureInfo zurückgegebenen Werte sind doppelt so viele Wie in der Spalte Attribute der Featuretabelle.

[out, optional] lpTitleBuf

Zeiger auf einen Puffer, um den lokalisierten Namen des Features zu erhalten, der dem Feld Titel in der Featuretabelle entspricht.

Dieser Parameter ist optional und kann NULL sein.

[in, out, optional] pcchTitleBuf

Als Eingabe die Größe von lpTitleBuf. Als Ausgabe die Anzahl der in lpTitleBuf zurückgegebenen Zeichen. Bei der Eingabe entspricht dies der vollständigen Größe des Puffers und enthält ein Leerzeichen für ein abschließendes NULL-Zeichen. Wenn der übergebene Puffer zu klein ist, enthält die zurückgegebene Anzahl nicht das abschließende NULL-Zeichen.

[out, optional] lpHelpBuf

Zeiger auf einen Puffer, um die lokalisierte Beschreibung des Features zu empfangen, die dem Feld Beschreibung für das Feature in der Featuretabelle entspricht. Dieser Parameter ist optional und kann NULL sein.

[in, out, optional] pcchHelpBuf

Als Eingabe die Größe von lpHelpBuf. Als Ausgabe die Anzahl der in lpHelpBuf zurückgegebenen Zeichen. Bei der Eingabe entspricht dies der vollständigen Größe des Puffers und enthält ein Leerzeichen für ein abschließendes NULL-Zeichen. Wenn der übergebene Puffer zu klein ist, enthält die zurückgegebene Anzahl nicht das abschließende NULL-Zeichen.

Rückgabewert

Rückgabecode Beschreibung
ERROR_INVALID_HANDLE
 Das Produkthandle ist ungültig.
ERROR_INVALID_PARAMETER
 Einer der Parameter ist ungültig.
ERROR_MORE_DATA
 Ein Puffer ist zu klein, um die angeforderten Daten zu speichern.
ERROR_SUCCESS
 Die Funktion gibt erfolgreich zurück.
ERROR_UNKNOWN_FEATURE
 Das Feature ist nicht bekannt.

Hinweise

Die Puffergrößen für die MsiGetFeatureInfo-Funktion sollten ein zusätzliches Zeichen für das abschließende NULL-Zeichen enthalten. Wenn ein Puffer zu klein ist, wird die zurückgegebene Zeichenfolge mit NULL abgeschnitten, und die Puffergröße enthält die Anzahl der Zeichen in der gesamten Zeichenfolge, ohne das abschließende NULL-Zeichen. Weitere Informationen finden Sie unter Aufrufen von Datenbankfunktionen aus Programmen.

Hinweis

Der msi.h-Header definiert MsiGetFeatureInfo als Alias, der die ANSI- oder Unicode-Version dieser Funktion basierend auf der Definition der UNICODE-Präprozessorkonstante automatisch auswählt. Das Mischen der Verwendung des codierungsneutralen Alias mit Code, der nicht Codierungsneutral ist, kann zu Nichtübereinstimmungen führen, die zu Kompilierungs- oder Laufzeitfehlern führen. Weitere Informationen finden Sie unter Konventionen für Funktionsprototypen.

Anforderungen

   
Unterstützte Mindestversion (Client) Windows Installer 5.0 unter Windows Server 2012, Windows 8, Windows Server 2008 R2 oder Windows 7. Windows Installer 4.0 oder Windows Installer 4.5 unter Windows Server 2008 oder Windows Vista. Windows Installer unter Windows Server 2003 oder Windows XP. Informationen zum mindestens erforderlichen Windows Service Pack für eine Windows Installer-Version finden Sie unter Windows Installer – Laufzeitanforderungen.
Zielplattform Windows
Kopfzeile msi.h
Bibliothek Msi.lib
DLL Msi.dll

Weitere Informationen

Produktabfragefunktionen