SetupCopyErrorA 函式 (setupapi.h)

發行項
03/01/2024

[此函式可用於需求一節中所述的操作系統。它在後續版本中可能會變更或無法使用。安裝程式API不應再用於安裝應用程式。請改用 Windows Installer 來開發應用程式安裝程式。 SetupAPI 會繼續用於安裝設備驅動器。]

SetupCopyError 函式會產生對話方塊，以通知使用者複製檔案錯誤。

語法

WINSETUPAPI UINT SetupCopyErrorA(
  [in]      HWND   hwndParent,
  [in]      PCSTR  DialogTitle,
  [in]      PCSTR  DiskName,
  [in]      PCSTR  PathToSource,
  [in]      PCSTR  SourceFile,
  [in]      PCSTR  TargetPathFile,
  [out]     UINT   Win32ErrorCode,
  [in]      DWORD  Style,
  [in, out] PSTR   PathBuffer,
  [in]      DWORD  PathBufferSize,
  [in, out] PDWORD PathRequiredSize
);

參數

[in] hwndParent

這個對話框之父視窗的句柄。

[in] DialogTitle

指定對話框標題 之 Null 終止字串的選擇性指標。

此參數可以是 Null。如果此參數為 NULL，則會使用當地語系化為系統語言 () 的預設標題「複製錯誤」。

[in] DiskName

指定要插入之磁碟名稱之 Null 終止字串的選擇性指標。

此參數可以是 Null。如果此參數為 NULL，則會使用當地語系化為系統語言) 的預設名稱「 (Unknown) (」。

[in] PathToSource

來源檔案路徑元件的指標，其中作業失敗，例如 F：\x86。

使用 以 Null 結尾的字串。

[in] SourceFile

Null 終止字串的指標，指定作業失敗之檔案的檔名部分。

使用 以 Null 結尾的字串。如果使用者按兩下 [ 詳細資料] 或 [ 瀏覽 ] 按鈕，就會顯示此檔名。 SetupCopyError 函式會尋找使用其壓縮格式名稱的檔案。因此，您可以傳遞 cmd.exe，而不擔心檔案實際上存在於來源媒體上cmd.ex_。

[in] TargetPathFile

指定目標檔案完整路徑以進行重新命名和複製作業之 Null 終止字串的選擇性指標。

使用 以 Null 結尾的字串。此參數可以是 Null。如果未指定 TargetPathFile，則會使用當地語系化為系統語言) 的 “ (Unknown) (”。

[out] Win32ErrorCode

如果發生錯誤，這個成員就是系統錯誤碼。

如果未發生錯誤，則會NO_ERROR。

[in] Style

控件顯示對話框格式設定和行為的旗標。

此參數可以是下列其中一個旗標。

IDF_NOBROWSE

不要顯示瀏覽選項。

IDF_NOSKIP

不要顯示 skip 檔案選項。

IDF_NODETAILS

不要顯示詳細數據選項。

如果設定此旗標，則可以省略 TargetPathFile 和 Win32ErrorCode 參數。

IDF_NOCOMPRESSED

請勿檢查原始程式檔的壓縮版本。

IDF_OEMDISK

作業來源是硬體製造商提供的磁碟。

IDF_NOBEEP

防止對話框在第一次出現時收到使用者的注意。

IDF_NOFOREGROUND

防止對話框成為前景視窗。

IDF_WARNIFSKIP

警告使用者略過檔案可能會影響安裝。

[in, out] PathBuffer

變數的選擇性指標，此變數會傳回路徑 (不包含使用者在對話框中指定之位置的檔名) 。您應該使用以 Null 結尾的字串。

以 Null 結尾的字串不應超過目的地緩衝區的大小。為了避免緩衝區錯誤不足， PathBuffer 至少應MAX_PATH。如需詳細資訊，請參閱本主題的一節。

[in] PathBufferSize

PathBuffer 所指向的緩衝區大小，以字元為單位。

緩衝區大小至少應MAX_PATH個字元，包括 Null 終止符。

[in, out] PathRequiredSize

變數的選擇性指標，此變數會傳回所需的緩衝區大小，以字元為單位，包括 Null 終止符。

傳回值

函式會傳回下列其中一個值。

若要取得擴充的錯誤資訊，請呼叫 GetLastError。

備註

如果使用 NULL 的 PathBuffer 呼叫此函式，而 PathBufferSize 為 0 (零) ，則函式會將所需的緩衝區大小放入 PathRequiredSize 所指向的變數中。

如果函式成功，傳回值會NO_ERROR。否則，傳回值是其中一個指定的值。

若要避免緩衝區錯誤不足， ReturnBuffer 至少應MAX_PATH。

注意

setupapi.h 標頭會將 SetupCopyError 定義為別名，根據 UNICODE 預處理器常數的定義，自動選取此函式的 ANSI 或 Unicode 版本。混合使用編碼中性別名與非編碼中性的程序代碼，可能會導致編譯或運行時間錯誤不符。如需詳細資訊，請參閱函式原型的慣例。

規格需求

需求	值
最低支援的用戶端	Windows XP [僅限傳統型應用程式]
最低支援的伺服器	Windows Server 2003 [僅限傳統型應用程式]
目標平台	Windows
標頭	setupapi.h
程式庫	Setupapi.lib
Dll	Setupapi.dll