Funzione MsiSummaryInfoGetPropertyA (msiquery.h)
La funzione MsiSummaryInfoGetProperty ottiene una singola proprietà dal flusso di informazioni di riepilogo.
Sintassi
UINT MsiSummaryInfoGetPropertyA(
[in] MSIHANDLE hSummaryInfo,
[in] UINT uiProperty,
[out] PUINT puiDataType,
[out] LPINT piValue,
[out] FILETIME *pftValue,
[out] LPSTR szValueBuf,
[in, out] LPDWORD pcchValueBuf
);
Parametri
[in] hSummaryInfo
Gestire le informazioni di riepilogo.
[in] uiProperty
Specifica l'ID proprietà della proprietà di riepilogo. Questo parametro può essere un ID proprietà elencato in Informazioni di riepilogo Stream Set di proprietà. Questa funzione non restituisce valori per la proprietà PID_DICTIONARY OR PID_THUMBNAIL.
[out] puiDataType
Riceve il tipo di proprietà restituito. Questo parametro può essere un tipo elencato in
Informazioni di riepilogo Stream set di proprietà.
[out] piValue
Riceve i dati della proprietà integer restituiti.
[out] pftValue
Puntatore a un valore di file.
[out] szValueBuf
Puntatore al buffer che riceve il valore della proprietà delle informazioni di riepilogo con terminazione Null. Non tentare di determinare le dimensioni del buffer passando un valore Null (value=0) per szValueBuf. È possibile ottenere le dimensioni del buffer passando una stringa vuota (ad esempio ""). La funzione restituisce quindi ERROR_MORE_DATA e pcchValueBuf contiene le dimensioni del buffer necessarie in TCHAR, senza includere il carattere null di terminazione. In caso di restituzione di ERROR_SUCCESS, pcchValueBuf contiene il numero di TCHAR scritti nel buffer, senza includere il carattere Null di terminazione. Questo parametro è una stringa vuota se non sono presenti errori.
[in, out] pcchValueBuf
Puntatore alla variabile che specifica le dimensioni, in TCHAR, del buffer a cui punta la variabile szValueBuf. Quando la funzione restituisce ERROR_SUCCESS, questa variabile contiene le dimensioni dei dati copiati in szValueBuf, senza includere il carattere null di terminazione. Se szValueBuf non è sufficientemente grande, la funzione restituisce ERROR_MORE_DATA e archivia le dimensioni necessarie, senza includere il carattere Null di terminazione, nella variabile a cui punta pcchValueBuf.
Valore restituito
La funzione MsiSummaryInfoGetProperty restituisce uno dei valori seguenti:
Commenti
Se viene restituito ERROR_MORE_DATA, il parametro che è un puntatore restituisce le dimensioni del buffer necessarie per contenere la stringa. Se viene restituito ERROR_SUCCESS, restituisce il numero di caratteri scritti nel buffer di stringhe. È pertanto possibile ottenere le dimensioni del buffer passando una stringa vuota (ad esempio "") per il parametro che specifica il buffer. Non tentare di determinare le dimensioni del buffer passando un valore Null (value=0).
Le funzioni di Windows Installer che restituiscono dati in un percorso di memoria fornito dall'utente non devono essere chiamate con null come valore per il puntatore. Queste funzioni restituiscono una stringa o restituiscono dati come puntatori integer, ma restituiscono valori incoerenti quando si passa null come valore per l'argomento di output. Per altre informazioni, vedere Passaggio di Null come argomento delle funzioni di Windows Installer.
Le informazioni sulla proprietà restituite dalla funzione MsiSummaryInfoGetProperty vengono ricevute dal parametro piValue, pftValue o szValueBuf a seconda del tipo di valore della proprietà specificato nel parametro puiDataType .
Nota
L'intestazione msiquery.h definisce MsiSummaryInfoGetProperty come alias che seleziona automaticamente la versione ANSI o Unicode di questa funzione in base alla definizione della costante del preprocessore UNICODE. La combinazione dell'utilizzo dell'alias indipendente dalla codifica con il codice che non è indipendente dalla codifica può causare mancate corrispondenze che generano errori di compilazione o di runtime. Per altre informazioni, vedere Convenzioni per i prototipi di funzioni.
Requisiti
Requisito | Valore |
---|---|
Client minimo supportato | Windows Installer 5.0 in Windows Server 2012, Windows 8, Windows Server 2008 R2 o Windows 7. Windows Installer 4.0 o Windows Installer 4.5 in Windows Server 2008 o Windows Vista. Windows Installer in Windows Server 2003 o Windows XP |
Piattaforma di destinazione | Windows |
Intestazione | msiquery.h |
Libreria | Msi.lib |
DLL | Msi.dll |
Vedi anche
Passaggio di Null come argomento delle funzioni di Windows Installer
Funzioni delle proprietà Summary Information