MsiEnumPatchesExW 函式 (msi.h)
MsiEnumPatchesEx函式會列舉特定內容或所有內容中的所有修補程式。 已套用至產品的修補程式會列舉。 也會列舉已註冊但尚未套用至產品的修補程式。
語法
UINT MsiEnumPatchesExW(
[in, optional] LPCWSTR szProductCode,
[in, optional] LPCWSTR szUserSid,
[in] DWORD dwContext,
[in] DWORD dwFilter,
[in] DWORD dwIndex,
[out, optional] WCHAR [39] szPatchCode,
[out, optional] WCHAR [39] szTargetProductCode,
[out, optional] MSIINSTALLCONTEXT *pdwTargetProductContext,
[out, optional] LPWSTR szTargetUserSid,
[in, out, optional] LPDWORD pcchTargetUserSid
);
參數
[in, optional] szProductCode
以 Null 結束的字串,指定列舉修補程式之產品的 ProductCode GUID。 如果為非Null,修補程式列舉僅限於 szUserSid 和 dwCoNtext所指定使用者和內容下此產品的實例。 如果 為 Null,則會列舉指定內容下所有產品的修補程式。
[in, optional] szUserSid
以 Null 終止的字串,指定限制列舉內容的安全性識別碼 (SID) 。 特殊 SID 字串 「S-1-1-0」 (Everyone) 會指定系統中所有使用者的列舉。 「S-1-1-0」 以外的 SID 值會被視為使用者 SID,並將列舉限制為該使用者。 針對目前使用者以外的使用者列舉時,不會列舉使用小於 Windows Installer 3.0 版之每一使用者 Unmanaged 內容中套用的任何修補程式。 這個參數可以設定為 Null ,以指定目前的使用者。
SID 類型 | 意義 |
---|---|
|
指定目前登入的使用者。 |
|
系統中特定使用者的列舉。 使用者 SID 的範例是 「S-1-3-64-2415071341-1358098788-3127455600-2561」。 |
|
系統中所有使用者的列舉。 |
[in] dwContext
將列舉限制為一個或多個內容組合。 此參數可以是下列值的任何一個或組合。
[in] dwFilter
列舉的篩選。 此參數可以是下列參數的其中一個或組合。
篩選 | 意義 |
---|---|
|
列舉包含已套用的修補程式。 列舉不包含已取代或過時的修補程式。 |
|
列舉包含標示為已取代的修補程式。 |
|
列舉包含標示為過時的修補程式。 |
|
列舉包含已註冊但尚未套用的修補程式。 MsiSourceListAddSourceEx函式可以註冊新的修補程式。
注意 未列舉為目前使用者以外的使用者註冊並套用至個別使用者 Unmanaged 內容中的修補程式。
|
|
列舉包括所有已套用、過時、已取代和已註冊的修補程式。 |
[in] dwIndex
要擷取之修補程式的索引。 第一次呼叫 MsiEnumPatchesEx 函式時,此參數必須為零,然後針對後續呼叫遞增。 只有在先前的呼叫傳回ERROR_SUCCESS時, dwIndex 參數才應該遞增。
[out, optional] szPatchCode
輸出緩衝區,包含要列舉之修補程式的 GUID。 緩衝區應該夠大,足以保存 GUID。 此參數可以是 Null。
[out, optional] szTargetProductCode
輸出緩衝區,包含接收此修補程式之產品的 ProductCode GUID。 緩衝區應該夠大,足以保存 GUID。 此參數可以是 Null。
[out, optional] pdwTargetProductContext
傳回要列舉之修補程式的內容。 輸出值可以是 MSIINSTALLCONTEXT_USERMANAGED、 MSIINSTALLCONTEXT_USERUNMANAGED或 MSIINSTALLCONTEXT_MACHINE。 此參數可以是 Null。
[out, optional] szTargetUserSid
輸出緩衝區,接收此修補程式實例所在的帳戶字串 SID。 這個緩衝區會針對每部電腦內容傳回空字串。
此緩衝區應該夠大,足以包含 SID。 如果緩衝區太小,函式會 傳回ERROR_MORE_DATA ,並將 *pcchTargetUserSid 設定為值中的 TCHAR 數目,不包括終止的 Null 字元。
如果 szTargetUserSid 設定為 Null , 且 pcchTargetUserSid 設定為有效的指標,則函式會傳回 ERROR_SUCCESS並將 *pcchTargetUserSid 設定為值中的 TCHAR 數目,不包括終止 的 Null 字元。 然後可以再次呼叫 函式以擷取值,而 szTargetUserSid 緩衝區夠大,足以包含 *pcchTargetUserSid + 1 個字元。
如果 szTargetUserSid 和 pcchTargetUserSid 都設定為 Null,則函式會傳回 ERROR_SUCCESS 如果值存在,而不需要擷取值。
[in, out, optional] pcchTargetUserSid
變數的指標,指定szTargetUserSid緩衝區中的TCHAR數目。 當函式傳回時,不論函式是否將值複製到指定的緩衝區,此參數都設定為要求值的大小。 大小會以要求值中的 TCHAR 數目傳回,不包括終止 Null 字元。
只有當szTargetUserSid也是Null時,此參數才能設定為Null,否則函式會傳回ERROR_INVALID_PARAMETER。
傳回值
MsiEnumPatchesEx函式會傳回下列其中一個值。
傳回碼 | 描述 |
---|---|
|
函式無法嘗試存取許可權不足的資源。 |
|
組態資料已損毀。 |
|
不正確參數會傳遞至 函式。 |
|
沒有其他要列舉的修補程式。 |
|
已成功列舉修補程式。 |
|
szProduct指定的產品未安裝在指定內容中的電腦上。 |
|
當 pcchTargetUserSid 指向小於複製 SID 所需的緩衝區大小時,就會傳回這個值。 在此情況下,使用者可以修正緩衝區,並針對相同的索引值再次呼叫 MsiEnumPatchesEx 。 |
備註
非系統管理員只能列舉其可見度內的修補程式。 系統管理員可以列舉其他使用者內容的修補程式。
注意
msi.h 標頭會將 MsiEnumPatchesEx 定義為別名,根據 UNICODE 預處理器常數的定義,自動選取此函式的 ANSI 或 Unicode 版本。 混合使用編碼中性別名與非編碼中性的程式碼,可能會導致編譯或執行時間錯誤不符。 如需詳細資訊,請參閱 函式原型的慣例。
需求
最低支援的用戶端 | Windows Server 2012、Windows 8、Windows Server 2008 R2 或 Windows 7 上的 Windows Installer 5.0。 Windows Server 2008 或 Windows Vista 上的 Windows Installer 4.0 或 Windows Installer 4.5。 如需 Windows Installer 版本所需的最低 Windows Service Pack 相關資訊,請參閱 Windows Installer Run-Time 需求。 |
目標平台 | Windows |
標頭 | msi.h |
程式庫 | Msi.lib |
Dll | Msi.dll |