IVsObjectList2.DoRename(UInt32, String, UInt32) 方法

  • 参考

定义

命名空间:
Microsoft.VisualStudio.Shell.Interop
程序集:
Microsoft.VisualStudio.Shell.Interop.8.0.dll
程序集:

请求给定的列表项执行重命名操作。

public:
 int DoRename(System::UInt32 index, System::String ^ pszNewName, System::UInt32 grfFlags);
public:
 int DoRename(unsigned int index, Platform::String ^ pszNewName, unsigned int grfFlags);
int DoRename(unsigned int index, std::wstring const & pszNewName, unsigned int grfFlags);
public int DoRename (uint index, string pszNewName, uint grfFlags);
abstract member DoRename : uint32 * string * uint32 -> int
Public Function DoRename (index As UInteger, pszNewName As String, grfFlags As UInteger) As Integer

参数

index
UInt32

中指定感兴趣的列表项的索引。

pszNewName
String

中指向以 null 结尾的字符串的指针，该字符串包含新名称。

grfFlags
UInt32

中一个标志，用于指示索引是多选的一部分。 值取自 _VSOBJOPFLAGS 枚举。

返回

Int32

如果该方法成功，则它会返回 S_OK。 如果该方法失败，则会返回错误代码。

注解

COM 签名

从 vsshell80：

[C++]

HRESULT IVsObjectList2::DoRename(  
   [in] ULONG Index,   
   [in] LPCOLESTR pszNewName,   
   [in] VSOBJOPFLAGS grfFlags  
);

DoRename当用户提交重命名操作时，环境将调用。 只有在调用了之后，才会调用此方法， CanRename pszNewName 这样您就有机会验证名称。 如果 DoRename 成功，则返回 S_OK ，否则返回错误，并设置丰富的错误消息以指示遇到的问题。

如果要重命名多个项，则环境会将设置 grfFlags 为指示 DoRename 正在进行多个调用。 环境还使用 grfFlags 参数指示要重命名的第一项和最后一项。 例如，您可以使用它为多个数据项创建单个撤消操作。

适用于