IKnownFolderManager::Metode pengalihan (shobjidl_core.h)

Artikel
03/13/2024

Mengalihkan permintaan folder untuk folder umum dan per pengguna.

Sintaks

HRESULT Redirect(
  [in]           REFKNOWNFOLDERID    rfid,
  [in, optional] HWND                hwnd,
  [in]           KF_REDIRECT_FLAGS   flags,
  [in, optional] LPCWSTR             pszTargetPath,
  [in]           UINT                cFolders,
  [in]           const KNOWNFOLDERID *pExclusion,
  [out]          LPWSTR              *ppszError
);

Parameter

[in] rfid

Jenis: REFKNOWNFOLDERID

Referensi ke KNOWNFOLDERID folder yang akan dialihkan.

[in, optional] hwnd

Jenis: HWND

Handel jendela induk yang digunakan untuk menampilkan dialog antarmuka pengguna kemajuan mesin salin saat KF_REDIRECT_WITH_UI diteruskan dalam parameter bendera . Jika tidak ada dialog kemajuan yang diperlukan, nilai ini bisa NULL.

[in] flags

Jenis: KF_REDIRECT_FLAGS

Opsi KF_REDIRECT_FLAGS untuk pengalihan.

[in, optional] pszTargetPath

Jenis: LPCWSTR

Penunjuk ke jalur baru untuk folder. Ini adalah string Unicode yang dihentikan null. Nilai ini bisa NULL.

[in] cFolders

Jenis: UINT

Jumlah nilai KNOWNFOLDERID dalam array di pExclusion.

[in] pExclusion

Jenis: KNOWNFOLDERID const*

Penunjuk ke array nilai KNOWNFOLDERID yang merujuk ke subfolder rfid yang harus dikecualikan dari pengalihan. Jika tidak ada subfolder yang dikecualikan, nilai ini bisa NULL.

[out] ppszError

Jenis: LPWSTR*

Ketika metode ini kembali, berisi alamat penunjuk ke string Unicode yang dihentikan null yang berisi pesan kesalahan jika dibuat. Nilai ini bisa NULL.

Mengembalikan nilai

Jenis: HRESULT

Mengembalikan S_OK jika berhasil, atau nilai kesalahan jika tidak, termasuk yang berikut ini:

Menampilkan kode	Deskripsi
E_INVALIDARG	Antara lain, nilai ini dapat menunjukkan bahwa parameter rfid mereferensikan KNOWNFOLDERID yang tidak ada pada sistem. Tidak semua nilai KNOWNFOLDERID ada di semua sistem. Gunakan IKnownFolderManager::GetFolderIds untuk mengambil kumpulan nilai KNOWNFOLDERID untuk sistem saat ini.

Persyaratan

Persyaratan	Nilai
Klien minimum yang didukung	Windows Vista [hanya aplikasi desktop]
Server minimum yang didukung	Windows Server 2008 [hanya aplikasi desktop]
Target Platform	Windows
Header	shobjidl_core.h (termasuk Shobjidl.h)

Lihat juga

IKnownFolderManager

Sampel Folder yang Diketahui

Bagikan melalui