IVsCfgProviderEvents.OnCfgNameRenamed(String, String) Method

Reference

Definition

Namespace:: Microsoft.VisualStudio.Shell.Interop

Assembly:: Microsoft.VisualStudio.Shell.Interop.dll

Assembly:: Microsoft.VisualStudio.Interop.dll

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

Notifies the environment when a configuration name has been renamed.

public:
 int OnCfgNameRenamed(System::String ^ pszOldName, System::String ^ lszNewName);

public:
 int OnCfgNameRenamed(Platform::String ^ pszOldName, Platform::String ^ lszNewName);

int OnCfgNameRenamed(std::wstring const & pszOldName, std::wstring const & lszNewName);

public int OnCfgNameRenamed (string pszOldName, string lszNewName);

abstract member OnCfgNameRenamed : string * string -> int

Public Function OnCfgNameRenamed (pszOldName As String, lszNewName As String) As Integer

Parameters

pszOldName: String

[in] Pointer to the original name of the configuration.

lszNewName: String

[in] Pointer to the new name of the configuration.

Returns

Int32

If the method succeeds, it returns S_OK. If it fails, it returns an error code.

Remarks

COM Signature

From vsshell.idl:

HRESULT IVsCfgProviderEvents::OnCfgNameRenamed(  
   [in] LPCOLESTR pszOldName,  
   [in] LPCOLESTR lszNewName  
);

If the configuration object renames configurations with a clone operation following by a delete operation, it will generate add and delete events rather than a rename event. That is, OnCfgNameAdded will be called following OnCfgNameDeleted instead of this method.

Applies to