Метод IFaxServer::CreateDocument (faxcom.h)

Метод IFaxServer::CreateDocument создает объект FaxDoc для указанного объекта FaxServer . Объект FaxDoc позволяет пользователю создавать и передавать документ одному или нескольким получателям факса.

Синтаксис

HRESULT CreateDocument(
  [in]  BSTR    FileName,
  [out] VARIANT *retval
);

Параметры

[in] FileName

Тип: BSTR

Указывает строку, заканчивающуюся null, которая содержит полный путь и имя файла, содержащего передаваемый факсимильный документ. Путь может быть UNC-путем или путем, начинающийся с буквы диска.

Этот параметр может содержать любое допустимое имя локального или удаленного файла. Файл должен иметь правильно зарегистрированный тип файла, а факс-сервер должен иметь доступ к файлу.

[out] retval

Тип: VARIANT*

Указатель на структуру VARIANT , получающую указатель интерфейса IDispatch на объект FaxDoc . Метод возвращает элемент pdispVal с типом данных VT_DISPATCH.

Возвращаемое значение

Тип: HRESULT

Если этот метод завершается успешно, он возвращает S_OK. В противном случае возвращается код ошибки HRESULT .

Комментарии

Метод IFaxServer::CreateDocument извлекает указатель интерфейса IDispatch на объект FaxDoc . Клиентское приложение факса также может получить доступ к интерфейсу IFaxDoc напрямую, вызвав метод IUnknown::QueryInterface для получения указателя интерфейса. Интерфейс IFaxDoc позволяет пользователю задать свойства для факсимильного документа, а затем передать документ.

Клиентское приложение факса не должно вызывать функцию CoCreateInstance для получения указателя интерфейса IFaxDoc , так как экземпляр не будет создан правильно.

Требования

Требование Значение
Минимальная версия клиента Windows 2000 Professional [только классические приложения]
Минимальная версия сервера Windows 2000 Server [только классические приложения]
Целевая платформа Windows
Header faxcom.h
DLL Faxcom.dll

См. также раздел

Интерфейсы API клиента службы факсов

API клиента службы факсов для Windows 2000

FaxDoc

FaxServer

IFaxServer

IUnknown::QueryInterface