msiSourceListEnumSourcesA 函式 (msi.h)

  • 發行項

MsiSourceListEnumSources函式會列舉指定修補程式或產品之來源清單中的來源。

語法

UINT MsiSourceListEnumSourcesA(
  [in]                LPCSTR            szProductCodeOrPatchCode,
  [in, optional]      LPCSTR            szUserSid,
  [in]                MSIINSTALLCONTEXT dwContext,
  [in]                DWORD             dwOptions,
  [in]                DWORD             dwIndex,
  [in, optional]      LPSTR             szSource,
  [in, out, optional] LPDWORD           pcchSource
);

參數

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

SID 的類型 意義
NULL
 Null表示登入的目前使用者。 參考目前的使用者帳戶時， szUserSID 可以是 Null ， 而 dwCoNtext 可以MSIINSTALLCONTEXT_USERMANAGED或MSIINSTALLCONTEXT_USERUNMANAGED。
使用者 SID
 系統中特定使用者的列舉。 使用者 SID 的範例為 「S-1-3-64-2415071341-1358098788-3127455600-2561」。
s-1-1-0
 特殊 SID 字串 s-1-1-0 (所有人) 指定系統中所有使用者的列舉。
 
注意 特殊 SID 字串 s-1-5-18 (系統) 無法用來列舉依每部電腦安裝的產品或修補程式。 將 SID 值設定為 s-1-5-18 會傳回ERROR_INVALID_PARAMETER。
 

[in] dwContext

產品或修補程式實例的內容。 此參數可以包含下列其中一個值。

內容類型 意義
MSIINSTALLCONTEXT_USERMANAGED
 產品或修補程式實例存在於每個使用者管理的內容中。
MSIINSTALLCONTEXT_USERUNMANAGED
 產品或修補程式實例存在於個別使用者 Unmanaged 內容中。
MSIINSTALLCONTEXT_MACHINE
 產品或修補程式實例存在於每部電腦內容中。

[in] dwOptions

dwOptions值會決定szProductCodeOrPatchCode值的解譯，以及要清除的來源類型。 此參數必須是下列其中一個MSISOURCETYPE_* 常數和下列其中一個MSICODE_* 常數的組合。

旗標 意義
MSISOURCETYPE_NETWORK
 來源是網路類型。
MSISOURCETYPE_URL
 來源是 URL 類型。
MSICODE_PRODUCT
 szProductCodeOrPatchCode 是產品代碼。
MSICODE_PATCH
 szProductCodeOrPatchCode 是修補程式程式碼。

[in] dwIndex

要擷取的來源索引。 對於第一次呼叫 MsiSourceListEnumSources 函式時，這個參數必須是 0 (零) ，然後針對後續呼叫遞增，直到函式傳回ERROR_NO_MORE_ITEMS為止。 只有當前一個呼叫傳回ERROR_SUCCESS時，才會遞增索引。

[in, optional] szSource

緩衝區的指標，接收所列舉之來源的路徑。 這個緩衝區應該夠大，足以包含收到的值。 如果緩衝區太小，函式會傳回ERROR_MORE_DATA，並將 *pcchSource 設定為值中的 TCHAR 數目，不包括終止的 Null 字元。

如果 szSource 設定為 Null 且 pcchSource 設定為有效的指標，則函式會傳回ERROR_SUCCESS，並將 *pcchSource 設定為值中的 TCHAR 數目，不包括終止的 Null 字元。 然後可以再次呼叫 函式以擷取值， szSource 緩衝區夠大，足以包含 *pcchSource + 1 個字元。

如果 szSource 和 pcchSource 都設定為 Null，則函式會在值存在時傳回ERROR_SUCCESS，而不擷取值。

[in, out, optional] pcchSource

指定szSource緩衝區中TCHAR數目的變數指標。 當函式傳回時，不論函式是否將值複製到指定的緩衝區，此參數會設定為要求值的大小。 大小會以要求值中的 TCHAR 數目傳回，不包括終止的 Null 字元。

只有當szSource也是Null時，此參數才能設定為Null，否則函式會傳回ERROR_INVALID_PARAMETER。

傳回值

MsiSourceListEnumSources函式會傳回下列值。

值 意義
ERROR_ACCESS_DENIED
 使用者無法讀取指定的來源清單。 這並不表示是否找到產品或修補程式。
ERROR_BAD_CONFIGURATION
 設定資料已損毀。
ERROR_INVALID_PARAMETER
 不正確參數會傳遞至 函式。
ERROR_MORE_DATA
 提供的緩衝區不足以包含要求的資料。
ERROR_NO_MORE_ITEMS
 指定的清單中沒有其他要列舉的來源。
ERROR_SUCCESS
 已成功列舉來源。
ERROR_UNKNOWN_PATCH
 指定的修補程式不會安裝在指定內容中的電腦上。
ERROR_UNKNOWN_PRODUCT
 指定的產品不會安裝在指定內容中的電腦上。
ERROR_FUNCTION_FAILED
 非預期的內部失敗。

備註

對 MsiSourceListEnumSources 進行多個呼叫以列舉單一產品實例的所有來源時，每個呼叫都必須從相同的執行緒進行。

系統管理員可以列舉每位使用者非受控和受控安裝，以自行列舉、每部電腦安裝，以及任何使用者的個別使用者受控安裝。 系統管理員無法列舉其他使用者的個別使用者非受控安裝。 非系統管理員只能列舉自己的個別使用者 Unmanaged 和 Managed 安裝和每部電腦安裝。

注意

msi.h 標頭會將 MsiSourceListEnumSources 定義為別名，根據 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 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

另請參閱

安裝內容

Windows Installer 2.0 和更早版本中不支援

ProductCode