IFaxServer

IFaxServer インターフェイスは、FAX クライアント アプリケーションが FAX サービスへの接続を管理するために使用するメッセージング コレクションを表します。

IFaxServer の既定の実装は、FaxServer オブジェクトとして提供されます。

IFaxServer::Connect メソッドは、FAX クライアント アプリケーションを指定した FAX サーバーに接続します。

型: HRESULT

このメソッドが成功した場合は S_OK を返します。それ以外の場合は HRESULT エラー コードを返します。

FAX 拡張コンポーネント オブジェクト モデル (COM) のほとんどのオブジェクトにアクセスする前に、アプリケーションはこのメソッドを呼び出して、アクティブな FAX サーバーとの接続を開始する必要があります。FaxDocument オブジェクトにアクセスする場合、FAX サーバーへの接続は不要です。クライアントがアクティブな FAX サーバーに接続していない場合、このメソッドは失敗します。

ローカル サーバーに接続するには、bstrServerName パラメーターに NULL または空の文字列を設定します。使用例については、「FAX サーバーへの接続」を参照してください。

IFaxServer::get_ServerName プロパティは、FAX クライアントが接続しているアクティブな FAX サーバーの名前を取得します。

IFaxServer::GetDeviceProviders メソッドは、FAX サービスに現在登録されている FAX サービス プロバイダー (FSP) のコレクションである IFaxDeviceProviders インターフェイスを作成します。

型: HRESULT

このメソッドが成功した場合は S_OK を返します。それ以外の場合は HRESULT エラー コードを返します。

このメソッドを使用するには、ユーザーが farQUERY_CONFIG アクセス権を持っている必要があります。

IFaxServer::GetDevices メソッドは、FAX サービスに現在登録されているすべての FAX サービス プロバイダー (FSP) が公開するすべての FAX デバイスのコレクションである IFaxDevices インターフェイスを作成します。

型: HRESULT

このメソッドが成功した場合は S_OK を返します。それ以外の場合は HRESULT エラー コードを返します。

IFaxDevices インターフェイスを使用すると、接続中の FAX サーバーに関連付けられた FAX デバイスを列挙し、それらに対応する IFaxDevice インターフェイスを作成できます。

このメソッドを使用するには、ユーザーが farQUERY_CONFIG アクセス権を持っている必要があります。

IFaxServer::get_InboundRouting プロパティは、IFaxInboundRouting 構成インターフェイスを作成します。このインターフェイスにより、受信 FAX ルーティング拡張機能とそのメソッドにアクセスできます。

IFaxServer::get_Folders プロパティは、IFaxFolders 構成インターフェイスにアクセスします。このインターフェイスを使用すると、接続中の FAX サーバー上のフォルダー、ジョブ、およびメッセージにアクセスできます。

IFaxServer::get_LoggingOptions プロパティは、IFaxLoggingOptions 構成インターフェイスを作成します。このインターフェイスにより、FAX サービスが使用するアクティビティ ログのオプションとイベント ログのカテゴリの両方を構成できます。

IFaxServer::get_MajorVersion プロパティは、FAX サービスのバージョン番号のメジャー部分を示す値です。

FAX サービスのビルド番号の形式は MajorVersion.MinorVersion.MajorBuild.MinorBuild です。

IFaxServer::get_MinorVersion プロパティは、FAX サービスのバージョン番号のマイナー部分を示す値です。

FAX サービスのビルド番号の形式は MajorVersion.MinorVersion.MajorBuild.MinorBuild です。

IFaxServer::get_MajorBuild プロパティは、FAX サービスのビルド番号のメジャー部分を示す値です。

FAX サービスのビルド番号の形式は MajorVersion.MinorVersion.MajorBuild.MinorBuild です。

IFaxServer::get_MinorBuild プロパティは、FAX サービスのビルド番号のマイナー部分を示す値です。

FAX サービスのビルド番号の形式は MajorVersion.MinorVersion.MajorBuild.MinorBuild です。

IFaxServer::get_Debug プロパティは、FAX サーバーがデバッグ環境で作成されたかどうかを示すブール値です。

このプロパティが TRUE の場合、FAX サーバーはデバッグ環境で作成されています。このプロパティが FALSE の場合、FAX サーバーはデバッグ環境では作成されていません。

IFaxServer::get_Activity プロパティは、IFaxActivity インターフェイス オブジェクトを作成します。このインターフェイスにより、FAX クライアント アプリケーションは、接続中の FAX サーバー上のアクティビティに関する情報と FAX サーバーの状態にアクセスできます。

IFaxServer::get_OutboundRouting プロパティは、IFaxOutboundRouting 構成インターフェイスを作成します。このインターフェイスにより、ユーザーは送信ルーティングのグループと規則を構成できます。

このプロパティは Windows XP ではサポートされておらず、エラー FAX_E_NOT_SUPPORTED_ON_THIS_SKU を返します。

IFaxServer::get_ReceiptOptions プロパティは、IFaxReceiptOptions 構成インターフェイスを作成します。このオブジェクトにより、FAX クライアント アプリケーションは、FAX サービスが FAX の受信確認を送信する際に使用する受信確認の構成を設定および取得できます。

IFaxServer::get_Security プロパティは、IFaxSecurity 構成インターフェイスを作成します。このインターフェイスにより、呼び出し元のアプリケーションは FAX サーバーのセキュリティ記述子を設定および取得できます。

IFaxServer::Disconnect メソッドは、FAX クライアント アプリケーションと FAX サーバーとの接続を終了します。クライアントがアクティブな FAX サーバーに接続していない場合、このメソッドは失敗します。

型: HRESULT

このメソッドが成功した場合は S_OK を返します。それ以外の場合は HRESULT エラー コードを返します。

IFaxServer::GetExtensionProperty メソッドは、サーバー レベルで格納されている拡張機能の構成プロパティを取得します。

型: HRESULT

このメソッドが成功した場合は S_OK を返します。それ以外の場合は HRESULT エラー コードを返します。

返されるデータは、unsigned char の VARIANT セーフ配列 (VT_UI1 | VT_ARRAY) として表現されるバイト列の BLOB です。このデータは、それを使用する特定の拡張機能に対してのみ意味を持ちます。詳細については、「FAX 拡張機能構成 API について」を参照してください。

このメソッドを使用するには、ユーザーが farQUERY_CONFIG アクセス権を持っている必要があります。

IFaxServer::SetExtensionProperty メソッドは、拡張機能の構成プロパティをサーバー レベルに格納します。

型: HRESULT

このメソッドが成功した場合は S_OK を返します。それ以外の場合は HRESULT エラー コードを返します。

拡張機能の構成プロパティは、unsigned char の VARIANT セーフ配列 (VT_UI1 | VT_ARRAY) として表現されるバイト列の BLOB です。このデータは、それを使用する特定の拡張機能に対してのみ意味を持ちます。詳細については、「FAX 拡張機能構成 API について」を参照してください。

このメソッドを使用するには、ユーザーが farMANAGE_CONFIG アクセス権を持っている必要があります。

IFaxServer::ListenToServerEvents メソッドは、1 種類以上のサーバー イベントに関する通知を受け取るように FaxServer オブジェクトを登録します。また、これらの通知を停止する場合にも使用します。

型: HRESULT

このメソッドが成功した場合は S_OK を返します。それ以外の場合は HRESULT エラー コードを返します。

Microsoft Visual Basic で FAX サーバーの通知を受け取るには、次の構文を使用して FaxServer オブジェクトを作成する必要があります。

Dim WithEvents objFaxServer As New FAXCOMEXLib.FaxServer
Set objFaxServer = CreateObject("FaxServer") 

Microsoft Visual C++ では、FaxServer オブジェクト上の IFaxServerNotify インターフェイスがイベントの通知を受け取ります。

既定では、FaxServer オブジェクトはどのサーバー イベントの通知も受け取りません。FaxServer オブジェクトで通知を受け取るには、IFaxServer::ListenToServerEvents を呼び出し、通知を受け取りたいイベントの種類を渡す必要があります。通知の受信を停止するには、EventTypes に fsetNONE を指定してこのメソッドを呼び出します。

このメソッドに必要なアクセス権は、要求するイベントによって次の表のように異なります。

IFaxServer::RegisterDeviceProvider メソッドは、FAX サービス プロバイダー (FSP) を FAX サービスに登録します。登録は FAX サービスの再起動後に有効になります。

型: HRESULT

このメソッドが成功した場合は S_OK を返します。それ以外の場合は HRESULT エラー コードを返します。

FSP を登録できるのは管理者のみです。

このメソッドを使用するには、ユーザーが farMANAGE_CONFIG アクセス権を持っている必要があります。

IFaxServer::UnregisterDeviceProvider メソッドは、既存のデバイス プロバイダーの登録を解除 (登録を削除) します。登録解除は、FAX サーバーの再起動後にのみ有効になります。

型: HRESULT

このメソッドが成功した場合は S_OK を返します。それ以外の場合は HRESULT エラー コードを返します。

FAX サービス プロバイダーの登録を解除できるのは管理者のみです。

このメソッドを使用するには、ユーザーが farMANAGE_CONFIG アクセス権を持っている必要があります。

IFaxServer::RegisterInboundRoutingExtension メソッドは、FAX の受信ルーティング拡張機能を FAX サービスに登録します。登録は FAX サービスの再起動後に有効になります。

型: HRESULT

このメソッドが成功した場合は S_OK を返します。それ以外の場合は HRESULT エラー コードを返します。

ルーティング拡張機能を登録できるのは管理者のみです。また、このメソッドはローカルの FAX サーバーでのみ動作します。

このプロパティは Windows XP ではサポートされておらず、エラー FAX_E_NOT_SUPPORTED_ON_THIS_SKU を返します。

このメソッドを使用するには、ユーザーが farMANAGE_CONFIG アクセス権を持っている必要があります。

IFaxServer::UnregisterInboundRoutingExtension メソッドは、既存の受信ルーティング拡張機能の登録を解除します。登録解除は、FAX サーバーの再起動後にのみ有効になります。

型: HRESULT

このメソッドが成功した場合は S_OK を返します。それ以外の場合は HRESULT エラー コードを返します。

ルーティング拡張機能の登録を解除できるのは管理者のみです。また、このメソッドはローカルの FAX サーバーでのみ動作します。

このメソッドを使用するには、ユーザーが farMANAGE_CONFIG アクセス権を持っている必要があります。

IFaxServer::get_RegisteredEvents プロパティは、クライアント アプリケーションが待機している FAX サービス イベントの種類を示す、列挙体の値です。

IFaxServer::get_APIVersion プロパティは、FAX サーバー API のバージョンを示す値です。

一般に、FAX サーバー API の新しいバージョンは、以前の API バージョンと完全に互換性があります。コンポーネント オブジェクト モデル (COM) オブジェクトを使用して FAX サーバーに接続する場合、COM 層が変換とマッピングを行い、サーバーの FAX API バージョンを透過的にサポートするため、FAX サーバーの API バージョンは必要ありません。ただし、接続先の FAX サーバーのバージョンを検出したい場合は、IFaxServer::get_APIVersion プロパティを使用できます。