Metode IFileOperation::RenameItem (shobjidl_core.h)

Menyatakan satu item yang akan diberi nama tampilan baru.

Sintaks

HRESULT RenameItem(
  [in] IShellItem                 *psiItem,
  [in] LPCWSTR                    pszNewName,
  [in] IFileOperationProgressSink *pfopsItem
);

Parameter

[in] psiItem

Jenis: IShellItem*

Penunjuk ke IShellItem yang menentukan item sumber.

[in] pszNewName

Jenis: LPCWSTR

Arahkan ke nama tampilan baru item. Ini adalah string Unicode yang dihentikan null.

[in] pfopsItem

Jenis: IFileOperationProgressSink*

Arahkan ke objek IFileOperationProgressSink yang akan digunakan untuk pemberitahuan status dan kegagalan. Jika Anda memanggil IFileOperation::Advise untuk operasi keseluruhan, status kemajuan dan pemberitahuan kesalahan untuk operasi penggantian nama disertakan di sana, jadi atur parameter ini ke NULL.

Nilai kembali

Jenis: HRESULT

Jika metode ini berhasil, metode akan mengembalikan S_OK. Jika tidak, kode kesalahan HRESULT akan dikembalikan.

Keterangan

Metode ini tidak mengganti nama item, metode ini hanya menyatakan item yang akan diganti namanya. Untuk mengganti nama objek, Anda harus membuat setidaknya urutan panggilan yang dirinci di sini:

1. Panggil IFileOperation::RenameItem untuk mendeklarasikan nama baru.
2. Panggil IFileOperation::P erformOperations untuk memulai operasi ganti nama.

Persyaratan

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

IFileOperation

IFileOperation::RenameItems

PostRenameItem

PreRenameItem