IVsTrackProjectDocuments2.OnQueryRenameFile Method (IVsProject, String, String, VSRENAMEFILEFLAGS, Int32)
This method is called by a project to determine whether a file in the project can be renamed.
Assembly: Microsoft.VisualStudio.Shell.Interop (in Microsoft.VisualStudio.Shell.Interop.dll)
int OnQueryRenameFile( IVsProject pProject, string pszMkOldName, string pszMkNewName, VSRENAMEFILEFLAGS flags, out int pfRenameCanContinue )
Parameters
- pProject
-
Type:
Microsoft.VisualStudio.Shell.Interop.IVsProject
[in] Project containing the file to be renamed.
- pszMkOldName
-
Type:
System.String
[in] Path to the old file name.
- pszMkNewName
-
Type:
System.String
[in] Path to the new file name.
- flags
-
Type:
Microsoft.VisualStudio.Shell.Interop.VSRENAMEFILEFLAGS
[in] For a list of flags values, see VSRENAMEFILEFLAGS.
- pfRenameCanContinue
-
Type:
System.Int32
[out] This value is true if file renaming can continue.
Return Value
Type: System.Int32If the method succeeds, it returns S_OK. If it fails, it returns an error code.
From IVsTrackProjectDocuments2.idl
HRESULT IVsTrackProjectDocuments2::OnQueryRenameFile( [in] IVsProject *pProject, [in] LPCOLESTR pszMkOldName, [in] LPCOLESTR pszMkNewName, [in] VSRENAMEFILEFLAGS flags, [out] BOOL *pfRenameCanContinue );
Call this method when you want to rename a file in the project. This method must be called before the file is renamed in the project. The environment returns a flag indicating whether the file can be renamed. After you have received authorization to rename the file and you have renamed it, call OnAfterRenameFile to confirm that the file has been renamed and to provide the environment with the new name.