IVsUIShell.SaveDocDataToFile(VSSAVEFLAGS, Object, String, String, Int32) Метод
Определение
Важно!
Некоторые сведения относятся к предварительной версии продукта, в которую до выпуска могут быть внесены существенные изменения. Майкрософт не предоставляет никаких гарантий, явных или подразумеваемых, относительно приведенных здесь сведений.
Вспомогательный метод, используемые редакторами, которые реализуют интерфейс IVsPersistDocData.
public:
int SaveDocDataToFile(Microsoft::VisualStudio::Shell::Interop::VSSAVEFLAGS grfSave, System::Object ^ pPersistFile, System::String ^ pszUntitledPath, [Runtime::InteropServices::Out] System::String ^ % pbstrDocumentNew, [Runtime::InteropServices::Out] int % pfCanceled);
int SaveDocDataToFile(Microsoft::VisualStudio::Shell::Interop::VSSAVEFLAGS grfSave, winrt::Windows::Foundation::IInspectable const & pPersistFile, std::wstring const & pszUntitledPath, [Runtime::InteropServices::Out] std::wstring const & & pbstrDocumentNew, [Runtime::InteropServices::Out] int & pfCanceled);
public int SaveDocDataToFile (Microsoft.VisualStudio.Shell.Interop.VSSAVEFLAGS grfSave, object pPersistFile, string pszUntitledPath, out string pbstrDocumentNew, out int pfCanceled);
abstract member SaveDocDataToFile : Microsoft.VisualStudio.Shell.Interop.VSSAVEFLAGS * obj * string * string * int -> int
Public Function SaveDocDataToFile (grfSave As VSSAVEFLAGS, pPersistFile As Object, pszUntitledPath As String, ByRef pbstrDocumentNew As String, ByRef pfCanceled As Integer) As Integer
Параметры
- grfSave
- VSSAVEFLAGS
[in] Указывает параметры сохранения файла. Для получения дополнительной информации см. VSSAVEFLAGS.
- pPersistFile
- Object
[in] Указатель на интерфейс IUnknown файла, в котором должны быть сохранены данные документа.
- pszUntitledPath
- String
[in] Путь к файлу, в котором необходимо сохранить данные по еще не сохраненным документам.
- pbstrDocumentNew
- String
[out] Новое имя файла документа.
- pfCanceled
- Int32
заполняет Задайте значение, true Если пользователь прерывает сохранение, нажав кнопку Отмена.
Возвращаемое значение
Если метод завершается успешно, возвращает значение S_OK. В противном случае функция возвращает код ошибки.
Комментарии
Подпись COM
Из всшелл. IDL:
HRESULT IVsUIShell::SaveDocDataToFile(
[in] VSSAVEFLAGS grfSave,
[in] IUnknown *pPersistFile,
[in] LPCOLESTR pszUntitledPath,
[out] BSTR *pbstrDocumentNew,
[out] BOOL *pfCanceled
);
Этот метод помогает реализовать диалоговое окно « Сохранить как ». Объект данных документа реализует IPersistFileFormat для выполнения операции сохранения. Этот метод управляет диалоговым окном Сохранить как , используя IPersistFileFormat указатель, переданный в качестве входных данных.
Стандартный случай — когда документ сохраняет всю информацию в файле. Как правило, операция сохранения завершается неудачей, если возникает проблема с назначением (например, диск полон, защищена запись на диск, неправильное и т. д.). Не ожидается, что объект не должен завершать операцию сохранения по другим причинам, чем неверный вариант назначения. Таким образом, если сохранение не удалось, пользователю сообщается о проблеме и появляется диалоговое окно, в котором можно выбрать новое назначение (то есть диалоговое окно « Сохранить как »). В случае, когда документ сохраняет некоторую информацию в отдельном хранилище и другие сведения в файле, если сохранение первой информации в отдельном хранилище завершается неудачей, то нет никакой точки в попытке выполнить другое назначение для части файла. В этом случае документ возвращает значение OLE_E_PROMPTSAVECANCELED из Save .