RunningDocumentTable.SaveFileIfDirty Method
Saves the specified file if it has changed since the last save.
Namespace: Microsoft.VisualStudio.Shell
Assembly: Microsoft.VisualStudio.Shell.12.0 (in Microsoft.VisualStudio.Shell.12.0.dll)
Syntax
'Declaration
Public Function SaveFileIfDirty ( _
fullPath As String _
) As String
public string SaveFileIfDirty(
string fullPath
)
public:
String^ SaveFileIfDirty(
String^ fullPath
)
member SaveFileIfDirty :
fullPath:string -> string
public function SaveFileIfDirty(
fullPath : String
) : String
Parameters
fullPath
Type: String[in] The full path to the document to be saved.
Return Value
Type: String
The path to which the file was saved. This is either the original path or a new path specified by the user.
Remarks
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.
.NET Framework Security
- Full trust for the immediate caller. This member cannot be used by partially trusted code. For more information, see Using Libraries from Partially Trusted Code.