MsiSummaryInfoGetPropertyW-Funktion (msiquery.h)

Artikel
11/20/2024

Die MsiSummaryInfoGetProperty--Funktion ruft eine einzelne Eigenschaft aus dem Zusammenfassungsinformationsstreamab.

Hinweis Die Bedeutung des Eigenschaftswerts hängt davon ab, ob der Zusammenfassungsinformationsdatenstrom für eine Installationsdatenbank (.msi Datei), Transformation (MST-Datei) oder Patchdatei (MSP-Datei) bestimmt ist. Weitere Informationen zu Zusammenfassungsinformationen zu Eigenschafteneigenschaften finden Sie unter Zusammenfassungseigenschaftenbeschreibungen und für Zusammenfassungsinformationen.

Syntax

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

Parameter

[in] hSummaryInfo

Behandeln sie zusammenfassungsinformationen.

[in] uiProperty

Gibt die Eigenschafts-ID der Zusammenfassungseigenschaft an. Dieser Parameter kann eine Eigenschafts-ID sein, die im Eigenschaftensatz "Zusammenfassungsinformationsdatenstrom"aufgeführt ist. Diese Funktion gibt keine Werte für PID_DICTIONARY OR PID_THUMBNAIL-Eigenschaft zurück.

[out] puiDataType

Empfängt den zurückgegebenen Eigenschaftstyp. Dieser Parameter kann ein Typ sein, der in der
Eigenschaftensatz "Zusammenfassungsinformation stream".

[out] piValue

Empfängt die zurückgegebenen ganzzahligen Eigenschaftsdaten.

[out] pftValue

Zeigen Sie auf einen Dateiwert.

[out] szValueBuf

Zeigen Sie auf den Puffer, der den Wert der null beendeten Zusammenfassungsinformationseigenschaft empfängt. Versuchen Sie nicht, die Größe des Puffers zu ermitteln, indem Sie für szValueBufeinen Nullwert (Wert=0) ü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, nicht einschließlich des endenden Nullzeichens. Bei Rückgabe von ERROR_SUCCESS enthält pcchValueBuf- die Anzahl der TCHARs, die in den Puffer geschrieben, nicht einschließlich des endenden Nullzeichens. Dieser Parameter ist eine leere Zeichenfolge, wenn keine Fehler vorhanden sind.

[in, out] pcchValueBuf

Zeigen Sie auf die Variable, die die Größe des Puffers in TCHARs-angibt, auf den die Variable szValueBufverweist. Wenn die Funktion ERROR_SUCCESS zurückgibt, enthält diese Variable die Größe der in szValueBufkopierten Daten, nicht einschließlich des endenden Nullzeichens. Wenn szValueBuf nicht groß genug ist, gibt die Funktion ERROR_MORE_DATA zurück und speichert die erforderliche Größe, nicht einschließlich des endenden NULL-Zeichens, in der Variablen, auf die pcchValueBufverweist.

Rückgabewert

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

Bemerkungen

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, gibt sie die Anzahl der Zeichen an, die in den Zeichenfolgenpuffer geschrieben wurden. 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 ermitteln, indem Sie einen Nullwert (Wert=0) übergeben.

Windows Installer-Funktionen, die Daten in einem vom Benutzer bereitgestellten Speicherort zurückgeben, sollten nicht mit NULL als Wert für den Zeiger aufgerufen werden. Diese Funktionen geben eine Zeichenfolge zurück oder geben Daten als ganzzahlige Zeiger zurück, 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 der Windows Installer-Funktionen.

Die eigenschafteninformationen, die von der MsiSummaryInfoGetProperty Function zurückgegeben werden, werden von der piValue, pftValueoder szValueBuf Parameter abhängig vom Typ des Eigenschaftswerts empfangen, der im puiDataType Parameter angegeben wurde.

Anmerkung

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

Anforderung	Wert
mindestens unterstützte 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-	Fenster
Header-	msiquery.h
Library	Msi.lib
DLL-	Msi.dll

Siehe auch

Übergeben von Null als Argument von Windows Installer-Funktionen

Funktionen für zusammenfassungsinformationen

Eigenschaftensatz "Zusammenfassungsinformationen stream"

Summaryinfo.Property

Freigeben über