MsiSummaryInfoGetPropertyA-Funktion (msiquery.h)

Die MsiSummaryInfoGetProperty-Funktion ruft eine einzelne Eigenschaft aus dem Zusammenfassungsinformationsstream ab.

Hinweis Die Bedeutung des Eigenschaftswerts hängt davon ab, ob der Zusammenfassungsinformationsstream für eine Installationsdatenbank (.msi Datei), eine Transformation (MST-Datei) oder einen Patch (MSP-Datei) verwendet wird. Weitere Informationen zu Zusammenfassungsinformationen finden Sie unter Beschreibungen von Zusammenfassungseigenschaften und ZusammenfassungsinformationenStream Eigenschaftensatz.

 

Syntax

UINT MsiSummaryInfoGetPropertyA(
  [in]      MSIHANDLE hSummaryInfo,
  [in]      UINT      uiProperty,
  [out]     PUINT     puiDataType,
  [out]     LPINT     piValue,
  [out]     FILETIME  *pftValue,
  [out]     LPSTR     szValueBuf,
  [in, out] LPDWORD   pcchValueBuf
);

Parameter

[in] hSummaryInfo

Verarbeiten von Zusammenfassungsinformationen.

[in] uiProperty

Gibt die Eigenschafts-ID der Zusammenfassungseigenschaft an. Bei diesem Parameter kann es sich um eine Eigenschafts-ID handelt, die im Eigenschaftensatz Zusammenfassungsinformationen Stream aufgeführt ist. Diese Funktion gibt keine Werte für PID_DICTIONARY EIGENSCHAFT OR PID_THUMBNAIL zurück.

[out] puiDataType

Empfängt den zurückgegebenen Eigenschaftstyp. Bei diesem Parameter kann es sich um einen Typ handeln, der im
Zusammenfassungsinformationen Stream Eigenschaftensatz.

[out] piValue

Empfängt die zurückgegebenen ganzzahligen Eigenschaftendaten.

[out] pftValue

Zeiger auf einen Dateiwert.

[out] szValueBuf

Zeiger auf den Puffer, der den Eigenschaftswert für die Zusammenfassungsinformation mit NULL-Beendigung empfängt. Versuchen Sie nicht, die Größe des Puffers zu bestimmen, indem Sie null (value=0) für szValueBuf übergeben. Sie können die Größe des Puffers abrufen, indem Sie eine leere Zeichenfolge übergeben (z. B. "). Die Funktion gibt dann ERROR_MORE_DATA zurück, und pcchValueBuf enthält die erforderliche Puffergröße in TCHARs, ohne das beendende NULL-Zeichen. Bei Rückgabe von ERROR_SUCCESS enthält pcchValueBuf die Anzahl der TCHARs , die in den Puffer geschrieben wurden, ohne das beendende NULL-Zeichen. Dieser Parameter ist eine leere Zeichenfolge, wenn keine Fehler vorliegen.

[in, out] pcchValueBuf

Zeiger auf die Variable, die in TCHARs die Größe des Puffers angibt, auf den die Variable szValueBuf verweist. Wenn die Funktion ERROR_SUCCESS zurückgibt, enthält diese Variable die Größe der in szValueBuf kopierten Daten, ohne das beendende NULL-Zeichen. Wenn szValueBuf nicht groß genug ist, gibt die Funktion ERROR_MORE_DATA zurück und speichert die erforderliche Größe ohne das beendende NULL-Zeichen in der Variablen, auf die von pcchValueBuf verwiesen wird.

Rückgabewert

Die MsiSummaryInfoGetProperty-Funktion gibt einen der folgenden Werte zurück:

Hinweise

Wenn ERROR_MORE_DATA zurückgegeben wird, gibt der Parameter, der ein Zeiger ist, die Größe des Puffers an, der zum Halten der Zeichenfolge erforderlich ist. Wenn ERROR_SUCCESS zurückgegeben wird, wird die Anzahl der Zeichen in den Zeichenfolgenpuffer geschrieben. Daher können Sie die Größe des Puffers abrufen, indem Sie eine leere Zeichenfolge (z. B. "") für den Parameter übergeben, der den Puffer angibt. Versuchen Sie nicht, die Größe des Puffers zu bestimmen, indem Sie null (value=0) übergeben.

Windows Installer-Funktionen, die Daten in einem vom Benutzer bereitgestellten Speicherspeicherort zurückgeben, sollten nicht mit NULL als Wert für den Zeiger aufgerufen werden. Diese Funktionen geben eine Zeichenfolge oder Daten als ganzzahlige Zeiger zurück. Sie geben jedoch inkonsistente Werte zurück, wenn NULL als Wert für das Ausgabeargument übergeben wird. Weitere Informationen finden Sie unter Übergeben von NULL als Argument von Windows Installer-Funktionen.

Die von der MsiSummaryInfoGetProperty-Funktion zurückgegebenen Eigenschafteninformationen werden vom PiValue-, pftValue- oder szValueBuf-Parameter empfangen, abhängig vom Typ des Eigenschaftswerts, der im puiDataType-Parameter angegeben wurde.

Hinweis

Der msiquery.h-Header definiert MsiSummaryInfoGetProperty 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 nicht codierungsneutralem Code kann zu Nichtübereinstimmungen führen, die zu Kompilierungs- oder Laufzeitfehlern führen. Weitere Informationen finden Sie unter Konventionen für Funktionsprototypen.

Anforderungen

Anforderung	Wert
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
Zielplattform	Windows
Kopfzeile	msiquery.h
Bibliothek	Msi.lib
DLL	Msi.dll

Weitere Informationen

Übergeben von Null als Argument von Windows Installer-Funktionen

Eigenschaftenfunktionen für Zusammenfassungsinformationen

Eigenschaftensatz für den zusammenfassenden Informationsdatenstrom

Summaryinfo.Property