struktur KNOWNFOLDER_DEFINITION (shobjidl_core.h)

Menentukan spesifikasi folder yang diketahui.

Sintaks

typedef struct KNOWNFOLDER_DEFINITION {
  KF_CATEGORY         category;
  LPWSTR              pszName;
  LPWSTR              pszDescription;
  KNOWNFOLDERID       fidParent;
  LPWSTR              pszRelativePath;
  LPWSTR              pszParsingName;
  LPWSTR              pszTooltip;
  LPWSTR              pszLocalizedName;
  LPWSTR              pszIcon;
  LPWSTR              pszSecurity;
  DWORD               dwAttributes;
  KF_DEFINITION_FLAGS kfdFlags;
  FOLDERTYPEID        ftidType;
} KNOWNFOLDER_DEFINITION;

Anggota

category

Jenis: KF_CATEGORY

Satu nilai dari konstanta KF_CATEGORY yang mengklasifikasikan folder sebagai virtual, tetap, umum, atau per pengguna.

pszName

Jenis: LPWSTR

Penunjuk ke nama kanonis yang tidak dilokalkan untuk folder yang diketahui, disimpan sebagai string Unicode yang dihentikan null. Jika folder ini adalah folder umum atau per pengguna, nilai ini juga digunakan sebagai nama nilai pengaturan registri "Folder Shell Pengguna". Nama ini dimaksudkan untuk menjadi nama unik yang dapat dibaca manusia. Pihak ketiga disarankan untuk mengikuti format Company.Application.Name. Nama yang diberikan di sini tidak boleh dikacaukan dengan nama tampilan.

pszDescription

Jenis: LPWSTR

Penunjuk ke deskripsi singkat folder yang diketahui, disimpan sebagai string Unicode yang dihentikan null. Deskripsi ini harus mencakup tujuan dan penggunaan folder.

fidParent

Jenis: KNOWNFOLDERID

Nilai KNOWNFOLDERID yang menamai folder lain yang diketahui untuk berfungsi sebagai folder induk. Berlaku hanya untuk folder umum dan per pengguna. Nilai ini digunakan bersama dengan pszRelativePath. Lihat Keterangan untuk detail selengkapnya.

Nilai ini bersifat opsional jika tidak ada nilai yang disediakan untuk pszRelativePath.

pszRelativePath

Jenis: LPWSTR

Pilihan. Penunjuk ke jalur yang relatif terhadap folder induk yang ditentukan dalam fidParent. Ini adalah string Unicode yang dihentikan null, mengacu pada jalur sistem file fisik, dan tidak dilokalkan. Berlaku hanya untuk folder umum dan per pengguna. Lihat Keterangan untuk detail selengkapnya.

pszParsingName

Jenis: LPWSTR

Penunjuk ke jalur folder namespace Shell folder, disimpan sebagai string Unicode yang dihentikan null. Hanya berlaku untuk folder virtual. Misalnya, Control Panel memiliki nama penguraian ::%CLSID_MyComputer%::%CLSID_ControlPanel%.

pszTooltip

Jenis: LPWSTR

Pilihan. Penunjuk ke sumber daya tipsalat default yang digunakan untuk folder yang diketahui ini saat dibuat. Ini adalah string Unicode yang dihentikan null dalam bentuk ini:

Nama modul, ID Sumber Daya

Misalnya, @%_SYS_MOD_PATH%,-12688 adalah tipsalat untuk Gambar Umum. Saat folder dibuat, string ini disimpan dalam salinan Desktop.ini folder tersebut. Ini dapat diubah nanti oleh API Shell lainnya. Sumber daya ini mungkin dilokalkan.

Informasi ini tidak diperlukan untuk folder virtual.

pszLocalizedName

Jenis: LPWSTR

Opsional. Penunjuk ke sumber daya nama default yang dilokalkan yang digunakan saat folder dibuat. Ini adalah string Unicode yang dihentikan null dalam bentuk ini:

Nama modul, ID Sumber Daya

Saat folder dibuat, string ini disimpan dalam salinan Desktop.ini folder tersebut. Ini dapat diubah nanti oleh API Shell lainnya.

Informasi ini tidak diperlukan untuk folder virtual.

pszIcon

Jenis: LPWSTR

Pilihan. Penunjuk ke sumber daya ikon default yang digunakan saat folder dibuat. Ini adalah string Unicode yang dihentikan null dalam bentuk ini:

Nama modul, ID Sumber Daya

Saat folder dibuat, string ini disimpan dalam salinan Desktop.ini folder tersebut. Ini dapat diubah nanti oleh API Shell lainnya.

Informasi ini tidak diperlukan untuk folder virtual.

pszSecurity

Jenis: LPWSTR

Opsional. Penunjuk ke string format Bahasa Definisi Deskriptor Keamanan . Ini adalah string Unicode yang dihentikan null yang menjelaskan deskriptor keamanan default yang diterima folder saat dibuat. Jika parameter ini NULL, folder baru mewarisi pendeskripsi keamanan induknya. Ini sangat berguna untuk folder umum yang diakses oleh semua pengguna.

dwAttributes

Jenis: DWORD

Pilihan. Atribut sistem file default yang diberikan ke folder ketika dibuat. Misalnya, file dapat disembunyikan dan baca-saja (FILE_ATTRIBUTE_HIDDEN dan FILE_ATTRIBUTE_READONLY). Untuk daftar lengkap nilai yang mungkin, lihat parameter dwFlagsAndAttributes dari fungsi CreateFile . Atur ke -1 jika tidak diperlukan.

kfdFlags

Jenis: KF_DEFINITION_FLAGS

Pilihan. Salah satu nilai lainnya dari enumerasi KF_DEFINITION_FLAGS yang memungkinkan Anda membatasi pengalihan, mengizinkan roaming PC-ke-PC, dan mengontrol waktu pembuatan folder yang diketahui. Atur ke 0 jika tidak diperlukan.

ftidType

Jenis: FOLDERTYPEID

Salah satu nilai FOLDERTYPEID yang mengidentifikasi jenis folder yang diketahui berdasarkan isinya (seperti dokumen, musik, atau foto). Nilai ini adalah GUID.

Keterangan

Nilai fidParent dan pszRelativePath bekerja sama. Misalnya, Anda menentukan folder bernama MyNewFolder dan ingin membuat folder itu sebagai ...< >Nama pengguna\AppData\Local\MyApp\MyNewFolder. Sediakan FOLDERID_LocalAppData di fidParent untuk mewakili ...< Nama> pengguna\AppData\Local. Sediakan "\MyApp\MyNewFolder" di pszRelativePath.

Persyaratan

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

Lihat juga

IKnownFolder::GetFolderDefinition

IKnownFolderManager::RegisterFolder

Sampel Folder yang Diketahui