RunningDocumentTable::SaveFileIfDirty Method (String^)

Visual Studio 2015
 

Saves the specified file if it has changed since the last save.

Namespace:   Microsoft.VisualStudio.Shell
Assembly:  Microsoft.VisualStudio.Shell.14.0 (in Microsoft.VisualStudio.Shell.14.0.dll)

C#
C++
F#
VB
Copy 
public:
String^ SaveFileIfDirty(
	String^ fullPath
)

Parameters

fullPath
Type: System::String^

[in] The full path to the document to be saved.

Return Value

Type: System::String^

The path to which the file was saved. This is either the original path or a new path specified by the user.

This method attempts to use the IVsPersistDocData2 interface from the document to save the document. If the IVsPersistDocData2 interface cannot be obtained from the document then the original path is returned. If the save fails for any reason or the document is not dirty, then the original path is returned. If the save succeeds, the path to which the document was saved is returned. In other words, there is no way to determine from this method if the document was saved or not.

Return to top
Show: