Fungsi NPGetPropertyText (npapi.h)

Mengambil nama tombol untuk ditambahkan ke kotak dialog properti untuk sumber daya jaringan.

Sintaks

DWORD NPGetPropertyText(
  [in]      DWORD  iButton,
  [in]      DWORD  nPropSel,
  [in]      LPWSTR lpName,
  [out]     LPWSTR lpButtonName,
  [in, out] DWORD  nButtonNameLen,
  [in]      DWORD  nType
);

Parameter

[in] iButton

Menunjukkan indeks tombol. Manajer File mendukung maksimal enam tombol. Parameter ini diberi nomor 1-6 untuk masing-masing tombol yang mungkin jika hanya satu file yang dipilih, atau 11-16 jika beberapa file dipilih.

[in] nPropSel

Menentukan item apa yang menjadi fokus kotak dialog properti. Ini bisa menjadi salah satu nilai berikut.

Nilai Makna
WNPS_FILE
Satu file.
WNPS_DIR
Satu direktori.
WNPS_MULT
Pilihan beberapa file, direktori, atau keduanya.

[in] lpName

Penunjuk ke string yang dihentikan null yang berisi nama item atau item yang akan dilihat atau diedit dengan cara kotak dialog. Satu-satunya item yang didukung adalah file dan direktori, sehingga nama item adalah nama file. Ini harus tidak ambigu, tidak berisi karakter kartubebas, dan sepenuhnya memenuhi syarat (misalnya, C:\LOCAL\EXAMPLE.DOC). Beberapa nama file harus dipisahkan dengan spasi. Nama file yang berisi spasi mungkin dikelilingi oleh tanda kutip (misalnya, "C:\File Saya"). Dalam hal ini. diperlakukan sebagai satu nama. Karakter tanda sisipan '^' juga dapat digunakan sebagai mekanisme kutipan untuk karakter tunggal (misalnya, C:\My^"File, "C:\My^"File" keduanya merujuk ke file C:\My"File).

[out] lpButtonName

Penunjuk ke buffer tempat penyedia jaringan harus menyalin nama tombol properti. Jika berhasil, buffer yang ditunjukkan oleh lpButtonName berisi nama tombol properti. Jika buffer ini, saat keluar, berisi string kosong, maka tombol yang sesuai dengan nama tersebut dan semua tombol yang berhasil akan dihapus dari kotak dialog. Penyedia jaringan tidak dapat "melewati" tombol.

[in, out] nButtonNameLen

Menentukan ukuran buffer lpButtonName dalam karakter, termasuk karakter null yang mengakhiri.

[in] nType

Menentukan tipe item, yang harus WNTYPE_FILE.

Mengembalikan nilai

Jika fungsi berhasil, fungsi harus mengembalikan WN_SUCCESS dan lpButtonName dapat digunakan. Jika menunjuk ke string kosong, tidak ada tombol yang sesuai dengan indeks setingkat iButton. Jika nilai yang dikembalikan selain WN_SUCCESS, penyedia juga harus memanggil SetLastError untuk mengatur informasi kesalahan yang diperluas. Kode kesalahan yang diperluas mencakup yang berikut ini.

Menampilkan kode Deskripsi
WN_OUT_OF_MEMORY
Tidak dapat memuat string dari sumber daya.
WN_MORE_DATA
Buffer yang diberikan terlalu kecil agar pas dengan teks tombol.
WN_BAD_VALUE
Parameter lpName adalah bentuk yang tidak terduga.
WN_NOT_SUPPORTED
Kotak dialog properti tidak didukung untuk jenis objek yang diberikan, nType.

Keterangan

Manajer File memanggil fungsi ini setiap kali kotak dialog properti dimunculkan, dan melakukan ini sebelum menampilkan kotak dialog. Jika pengguna mengklik tombol yang ditambahkan melalui fungsi ini oleh penyedia jaringan, fungsi NPPropertyDialog dipanggil dengan parameter yang sesuai.

Hanya File Manager yang memanggil NPGetPropertyText, dan menggunakan fungsi ini untuk file dan direktori.

Persyaratan

Persyaratan Nilai
Klien minimum yang didukung Windows XP [hanya aplikasi desktop]
Server minimum yang didukung Windows Server 2003 [hanya aplikasi desktop]
Target Platform Windows
Header npapi.h