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

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

[in] dwOptions

dwOptions 值，指定 szProductCodeOrPatchCode 的意義。

[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 安裝，以及每部電腦安裝。

規格需求

另請參閱

安裝內容

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

ProductCode