IVsQueryEditQuerySave2.QuerySaveFile Method

Article
10/26/2012

Notifies the environment that a file is about to be saved.

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

Syntax

'Declaration
Function QuerySaveFile ( _
    pszMkDocument As String, _
    rgf As UInteger, _
    pFileInfo As VSQEQS_FILE_ATTRIBUTE_DATA(), _
    <OutAttribute> ByRef pdwQSResult As UInteger _
) As Integer

'Usage
Dim instance As IVsQueryEditQuerySave2 
Dim pszMkDocument As String 
Dim rgf As UInteger 
Dim pFileInfo As VSQEQS_FILE_ATTRIBUTE_DATA()
Dim pdwQSResult As UInteger 
Dim returnValue As Integer 

returnValue = instance.QuerySaveFile(pszMkDocument, _
    rgf, pFileInfo, pdwQSResult)

int QuerySaveFile(
    string pszMkDocument,
    uint rgf,
    VSQEQS_FILE_ATTRIBUTE_DATA[] pFileInfo,
    out uint pdwQSResult
)

int QuerySaveFile(
    [InAttribute] String^ pszMkDocument, 
    [InAttribute] unsigned int rgf, 
    [InAttribute] array<VSQEQS_FILE_ATTRIBUTE_DATA>^ pFileInfo, 
    [OutAttribute] unsigned int% pdwQSResult
)

function QuerySaveFile(
    pszMkDocument : String, 
    rgf : uint, 
    pFileInfo : VSQEQS_FILE_ATTRIBUTE_DATA[], 
    pdwQSResult : uint
) : int

Parameters

pszMkDocument
Type: System.String

[in] Path to the file (document to be saved) on the disk.

rgf
Type: System.UInt32

[in] Flags whose values for valid file attributes are taken from the tagVSQEQSFlags enumeration. The default value is zero.

pFileInfo
Type: array<Microsoft.VisualStudio.Shell.Interop.VSQEQS_FILE_ATTRIBUTE_DATA[]

[in] Values taken from the VSQEQS_FILE_ATTRIBUTE_DATA structure containing information about the file attributes. Can be nulla null reference (Nothing in Visual Basic); is ignored if rgf is 0.

pdwQSResult
Type: System.UInt32%

[out] Pointer to a value taken from the tagVSQuerySaveResult enumeration.

Return Value

Type: System.Int32

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

QSR_SaveOK
Save the file. The file should not be read-only at this point.
QSR_ForceSaveAs
QuerySaveFile has not put up a Save As dialog box, but either it is quietly telling you to do so, or the user has been prompted and has selected Save As. If you are editing a conventional file, you are encouraged to call the GetSaveFileNameViaDlg method in the IVsUIShell interface at this point.
QSR_NoSave_UserCanceled
The user was notified that the file is read-only and has elected either to not save or to cancel the operation. The choice depends on the BeginQuerySaveBatch / EndQuerySaveBatch methods.

The results for *pdwQSResult are:

Proceed with save (QSR_SaveOK).
Do not save (QSR_NoSave_Continue).
Save as (QSR_ForceSaveAs).
Cancel Save (QSR_NoSave_UserCanceled or QSR_NoSave_Cancel).

Remarks

COM Signature

From ivsqueryeditquerysave2.idl

HRESULT QuerySaveFile(
   [in] LPCOLESTR pszMkDocument,
   [in] VSQEQSFlags rgf,
   [in] const VSQEQS_FILE_ATTRIBUTE_DATA *pFileInfo,
   [out, retval] VSQuerySaveResult *pdwQSResult
);

Before a project or editor saves a file, it must call this method or the QuerySaveFiles method. For project files, these calls are completed automatically by the solution, which knows when to save a project file. Editors are responsible for making these calls unless the editor implementation of IVsPersistDocData2 uses the helper function SaveDocDataToFile method. If your editor implements IVsPersistDocData2 in this way, then the call to QuerySaveFile or QuerySaveFiles is made for you.

Call this method before saving anything to disk. It will handle read-only and checked-in files in a uniform, shared way.

This method may need to issue a checkout command to ensure that the file is writable (for example, if the file was edited in memory). For a source control package that provides for the "checkout local version" option, this is a safe operation. For a source control package that does not, the checkout operation cannot be completed without data loss. In this case, Save As is the only option.

.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.

Share via