msiSourceListEnumMediaDisksA 函式 (msi.h)
MsiSourceListEnumMediaDisks 函式會列舉為修補程式或產品之媒體來源註冊的磁碟清單。
語法
UINT MsiSourceListEnumMediaDisksA(
[in] LPCSTR szProductCodeOrPatchCode,
[in, optional] LPCSTR szUserSid,
[in] MSIINSTALLCONTEXT dwContext,
[in] DWORD dwOptions,
[in] DWORD dwIndex,
[out, optional] LPDWORD pdwDiskId,
[out, optional] LPSTR szVolumeLabel,
[in, out, optional] LPDWORD pcchVolumeLabel,
[out, optional] LPSTR szDiskPrompt,
[in, out, optional] LPDWORD pcchDiskPrompt
);
參數
[in] szProductCodeOrPatchCode
產品或修補程式的 ProductCode 或修補程式 GUID。 使用以 Null 結尾的字串。 如果字串超過 39 個字元,則函式會失敗並傳回ERROR_INVALID_PARAMETER。 此參數不可為 NULL。
[in, optional] szUserSid
字串 SID,指定包含產品或修補程式的用戶帳戶。 SID 未經過驗證或解析。 不正確的 SID 可以傳回ERROR_UNKNOWN_PRODUCT或ERROR_UNKNOWN_PATCH。 參考計算機內容時, szUserSID 必須是 NULL ,且 dwContext 必須MSIINSTALLCONTEXT_MACHINE。
[in] dwContext
此參數會指定產品或修補程序實例的內容。 此參數可以包含下列其中一個值。
內容類型 | 意義 |
---|---|
|
產品或修補程序實例存在於每個使用者管理的內容中。 |
|
產品或修補程序實例存在於每位使用者 Unmanaged 內容中。 |
|
產品或修補程序實例存在於每部計算機內容中。 |
[in] dwOptions
dwOptions 值,指定 szProductCodeOrPatchCode 的意義。
旗標 | 意義 |
---|---|
|
szProductCodeOrPatchCode 是產品名稱 GUID。 |
|
szProductCodeOrPatchCode 是修補程式碼 GUID。 |
[in] dwIndex
要擷取的來源索引。 此參數必須是 0 (零) ,才能第一次呼叫 MsiSourceListEnumMediaDisks 函 式,然後針對後續呼叫遞增,直到函式傳回ERROR_NO_MORE_ITEMS為止。
[out, optional] pdwDiskId
在 MsiSourceListEnumMediaDisks 的專案上,此參數會提供 DWORD 的指標,以接收所列舉磁碟的標識碼。 這是選擇性參數。
[out, optional] szVolumeLabel
輸出緩衝區,接收所列舉磁碟的磁碟區標籤。 這個緩衝區應該夠大,足以包含資訊。 如果緩衝區太小,函式會傳回ERROR_MORE_DATA,並將 *pcchVolumeLabel 設定為值中的 TCHAR 數目,不包括終止的 NULL 字元。
如果 szVolumeLabel 和 pcchVolumeLabel 都設定為 NULL,則函式會傳回ERROR_SUCCESS如果值存在,而不擷取值。
[in, out, optional] pcchVolumeLabel
變數的指標,指定 szVolumeLabel 緩衝區中的 TCHAR 數目。 當函式傳回時,此參數是接收值中的 TCHAR 數目,不包括終止的 Null 字元。
只有當 szVolumeLabel 也是 NULL 時,此參數才能設定為 NULL,否則函式會傳回ERROR_INVALID_PARAMETER。
[out, optional] szDiskPrompt
輸出緩衝區,接收所列舉磁碟的磁碟提示。 這個緩衝區應該夠大,足以包含資訊。 如果緩衝區太小,函式會傳回ERROR_MORE_DATA,並將 *pcchDiskPrompt 設定為值中的 TCHAR 數目,不包括終止的 NULL 字元。
如果 szDiskPrompt 設定為 NULL , 且 pcchDiskPrompt 設定為有效的指標,則函式會傳回ERROR_SUCCESS,並將 *pcchDiskPrompt 設定為值中的 TCHAR 數目,不包括終止的 NULL 字元。 然後可以再次呼叫 函式以擷取值, 而 szDiskPrompt 緩衝區夠大,足以包含 *pcchDiskPrompt + 1 個字元。
如果 szDiskPrompt 和 pcchDiskPrompt 都設定為 NULL,則函式會傳回ERROR_SUCCESS如果值存在,而不擷取值。
[in, out, optional] pcchDiskPrompt
指定 szDiskPrompt 緩衝區中 TCHAR 數目的變數指標。 當函式傳回時,不論函式是否將值複製到指定的緩衝區,此參數都設定為要求值的大小。 大小會以要求值中的 TCHAR 數目傳回,不包括終止 Null 字元。
只有當 szDiskPrompt 也是 NULL 時,此參數才能設定為 NULL,否則函式會傳回ERROR_INVALID_PARAMETER。
傳回值
MsiSourceListEnumMediaDisks 函式會傳回下列值。
值 | 意義 |
---|---|
|
用戶無法讀取指定的媒體來源或指定的產品或修補程式。 這不會指出找到媒體來源、產品或修補程式。 |
|
組態數據已損毀。 |
|
無效的參數會傳遞至 函式。 |
|
此產品或修補程式不會再註冊任何磁碟。 |
|
已成功列舉值。 |
|
找不到修補程式。 |
|
找不到產品。 |
|
提供的緩衝區太小而無法包含要求的資訊。 |
|
非預期的內部失敗。 |
備註
對 MsiSourceListEnumMediaDisks 進行多個呼叫以列舉單一產品實例的所有來源時,每個呼叫都必須從相同的線程進行。
系統管理員可以列舉每位使用者的非受控和受控安裝,以針對任何使用者列舉個別計算機安裝,以及每個使用者的受控安裝。 系統管理員無法列舉其他使用者的個別使用者非受控安裝。 非系統管理員只能列舉自己的個別使用者 Unmanaged 和 Managed 安裝,以及每部電腦安裝。
注意
msi.h 標頭會根據 UNICODE 預處理器常數的定義,將 MsiSourceListEnumMediaDisks 定義為別名,自動選取此函式的 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 Server 2003 或 Windows XP 上的 Windows Installer 3.0 或更新版本。 如需 Windows Installer 版本所需的最低 Windows Service Pack 相關信息,請參閱 Windows Installer Run-Time 需求。 |
目標平台 | Windows |
標頭 | msi.h |
程式庫 | Msi.lib |
Dll | Msi.dll |