IPersistFileFormat.Save(String, Int32, UInt32) Метод
Определение
Важно!
Некоторые сведения относятся к предварительной версии продукта, в которую до выпуска могут быть внесены существенные изменения. Майкрософт не предоставляет никаких гарантий, явных или подразумеваемых, относительно приведенных здесь сведений.
Сохраняет копию объекта в заданном файле.
public:
int Save(System::String ^ pszFilename, int fRemember, System::UInt32 nFormatIndex);
public:
int Save(Platform::String ^ pszFilename, int fRemember, unsigned int nFormatIndex);
int Save(std::wstring const & pszFilename, int fRemember, unsigned int nFormatIndex);
public int Save (string pszFilename, int fRemember, uint nFormatIndex);
abstract member Save : string * int * uint32 -> int
Public Function Save (pszFilename As String, fRemember As Integer, nFormatIndex As UInteger) As Integer
Параметры
- pszFilename
- String
[in] Указатель на имя файла. pszFilenameПараметр может иметь значение null ; он указывает объекту сохраняться с помощью текущего файла. Если объект находится в состоянии без заголовка и null передается как pszFilename , объект возвращает E_INVALIDARG . В этой ситуации необходимо указать допустимый параметр имени файла.
- fRemember
- Int32
окне Логическое значение, указывающее, должен ли pszFileName параметр использоваться в качестве текущего рабочего файла. Если true , — pszFileName текущий файл, а объект должен очищать свой «грязный» флаг после сохранения. Если false задано значение, операция сохранения — сохранить копию как операцию. В этом случае текущий файл не изменяется и "грязный" флаг объекта не снимается. Если pszFileName имеет значение null , то в реализации игнорируется fRemember флаг.
- nFormatIndex
- UInt32
[in] Значение, указывающее формат, в котором будет сохранен файл. Вызывающая сторона передает DEF_FORMAT_INDEX, если объект должен выбрать свой формат по умолчанию (текущий). Если задано ненулевое значение, значение интерпретируется как индекс в списке форматов в том виде, в котором он возвращается вызовом метода GetFormatList(String). Значение индекса 0 указывает первый формат, 1 — второй формат и т. д.
Возвращаемое значение
Если метод завершается успешно, возвращает значение S_OK. В противном случае функция возвращает код ошибки.
Комментарии
Подпись COM
Из фпстфмт. IDL:
HRESULT IPersistFileFormat::Save(
[in] LPCOLESTR pszFilename,
[in] BOOL fRemember,
[in] DWORD nFormatIndex
);