IFileOperation::RenameItem メソッド (shobjidl_core.h)

新しい表示名を指定する 1 つの項目を宣言します。

構文

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

パラメーター

[in] psiItem

種類: IShellItem*

ソース アイテムを指定する IShellItem へのポインター。

[in] pszNewName

種類: LPCWSTR

項目の新しい 表示名 へのポインター。 これは null で終わる Unicode 文字列です。

[in] pfopsItem

種類: IFileOperationProgressSink*

状態通知とエラー通知に使用する IFileOperationProgressSink オブジェクトへのポインター。 操作全体に対して IFileOperation::Advise を呼び出すと、名前変更操作の進行状況とエラー通知がそこに含まれるため、このパラメーターを NULL に設定 します。

戻り値

種類: HRESULT

このメソッドは、成功すると S_OK を返します。 そうでない場合は、HRESULT エラー コードを返します。

解説

このメソッドはアイテムの名前を変更せず、名前を変更する項目を宣言するだけです。 オブジェクトの名前を変更するには、少なくともここで詳しく説明されている一連の呼び出しを行う必要があります。

1. IFileOperation::RenameItem を呼び出して、新しい名前を宣言します。
2. IFileOperation::P erformOperations を呼び出して、名前変更操作を開始します。

要件

サポートされている最小のクライアント	Windows Vista [デスクトップ アプリのみ]
サポートされている最小のサーバー	Windows Server 2008 [デスクトップ アプリのみ]
対象プラットフォーム	Windows
ヘッダー	shobjidl_core.h (Shobjidl.h を含む)

関連項目

IFileOperation

IFileOperation::RenameItems

PostRenameItem

PreRenameItem