IStorage::RenameElement メソッド (objidl.h)

RenameElement メソッドは、このストレージ オブジェクト内の指定されたサブストレージまたはストリームの名前を変更します。

構文

HRESULT RenameElement(
  [in] const OLECHAR *pwcsOldName,
  [in] const OLECHAR *pwcsNewName
);

パラメーター

[in] pwcsOldName

変更するサブストレージまたはストリームの名前を含むワイド文字の null で終わる Unicode 文字列へのポインター。

メモCreateStorage または CreateStream で作成された pwcsName は、文字列ターミネータを含めず、31 文字を超えてはなりません。

 

[in] pwcsNewName

指定したサブストレージまたはストリームの新しい名前を含むワイド文字の null で終わる Unicode 文字列へのポインター。

メモCreateStorage または CreateStream で作成された pwcsName は、文字列ターミネータを含めず、31 文字を超えてはなりません。

 

戻り値

このメソッドは、これらの値のいずれかを返すことができます。

リターン コード	説明
S_OK	要素の名前が正常に変更されました。
E_PENDING	非同期ストレージのみ: 要素のデータの一部またはすべてが現在使用できません。
STG_E_ACCESSDENIED	呼び出し元には、要素の名前を変更するための十分なアクセス許可がありません。
STG_E_FILENOTFOUND	指定した古い名前の要素が存在しません。
STG_E_FILEALREADYEXISTS	新しい名前で指定された要素は既に存在します。
STG_E_INSUFFICIENTMEMORY	メモリがないため、要素の名前が変更されませんでした。
STG_E_INVALIDNAME	いずれかの名前の値が無効です。
STG_E_INVALIDPOINTER	要素に指定されたポインターが無効でした。
STG_E_INVALIDPARAMETER	パラメーターの 1 つが無効でした。
STG_E_REVERTED	ストレージ オブジェクトは、トランザクション ツリーの上の元に戻す操作によって無効になっています。
STG_E_TOOMANYOPENFILES	開いているファイルが多すぎるため、要素の名前が変更されませんでした。

注釈

IStorage::RenameElement は、このストレージ オブジェクト内の指定されたサブストレージまたはストリームの名前を変更します。 ストレージ オブジェクト内の要素は、開いている間は名前を変更できません。 ストレージがトランザクション モードで開いている場合、名前変更操作は変更のコミットの対象となります。

IStorage::RenameElement メソッドは、ストレージ オブジェクトがトランザクション モードで開かれているメモリ不足で動作することは保証されません。 ダイレクト モードで動作する場合があります。

要件

要件	値
サポートされている最小のクライアント	Windows 2000 Professional [デスクトップ アプリ |UWP アプリ]
サポートされている最小のサーバー	Windows 2000 Server [デスクトップ アプリ |UWP アプリ]
対象プラットフォーム	Windows
ヘッダー	objidl.h
Library	Uuid.lib
[DLL]	Ole32.dll

こちらもご覧ください

IStorage - 複合ファイルの実装