3.1.4.1 Fax Server Interface

This protocol MUST specify to the RPC runtime that it is to perform a strict Network Data Representation (NDR) data consistency check at target level 5.0 ([MS-RPCE] section 3).

This protocol MUST specify to the RPC runtime via the type_strict_context_handle attribute, which rejects the use of context handles created by a method that creates a different type of context handle  ([MS-RPCE] section 3).

Methods in RPC Opnum Order

Method	Description
FAX_GetServicePrinters	This method is called by the client to obtain a list of printers that are visible to the fax service. Opnum: 0
FAX_ConnectionRefCount	This method is called by the client to connect, disconnect, or release a connection between the fax client and the fax server. Opnum: 1
FAX_OpenPort	This method is called by the client to open a fax port and obtain a fax port handle for subsequent use in other fax methods. Opnum: 2
FAX_ClosePort	This method is called by the client to close an opened fax port. Opnum: 3
FAX_EnumJobs	This method is called by the client to enumerate all the fax jobs on the specified fax server. Opnum: 4
FAX_GetJob	This method is called by the client to retrieve information about a specified fax job. Opnum: 5
FAX_SetJob	This method is called by the client to pause, resume, cancel, or restart a specified fax job. Opnum: 6
FAX_GetPageData	This method is called by the client to retrieve data in the first page of an outgoing fax job. Opnum: 7
FAX_GetDeviceStatus	This method is called by the client to retrieve information about a specified fax device (port). Opnum: 8
FAX_Abort	This method is called by the client to abort a specified fax job on the server. Opnum: 9
FAX_EnumPorts	This method is called by the client to enumerate and obtain information about all the devices (ports) on the server. Opnum: 10
FAX_GetPort	This method is called by the client to retrieve port status information for a specified port at the server. Opnum: 11
FAX_SetPort	This method is called by the client to set fax device information for a specified port at the server. Opnum: 12
FAX_EnumRoutingMethods	This method is called by the client to enumerate all the routing methods for a specified fax port that are registered with the fax server. Opnum: 13
FAX_EnableRoutingMethod	This method is called by the client to enable or disable a fax routing method for a specified fax device (port). Opnum: 14
FAX_GetRoutingInfo	This method is called by the client to retrieve information regarding a specified fax routing method. Opnum: 15
FAX_SetRoutingInfo	This method is called by the client to set routing information for a specified fax routing method. Opnum: 16
FAX_EnumGlobalRoutingInfo	This method is called by the client to enumerate global routing information. Opnum: 17
FAX_SetGlobalRoutingInfo	This method is called by the client to set global routing properties like the routing method priority. Opnum: 18
FAX_GetConfiguration	This method is called by the client to obtain the configuration settings on the fax server. Opnum: 19
FAX_SetConfiguration	This method is called by the client to change the configuration settings on the fax server. Opnum: 20
FAX_GetLoggingCategories	This method is called by the client to obtain the current logging categories for the fax server. Opnum: 21
FAX_SetLoggingCategories	This method is called by the client to modify the current logging categories for the fax server. Opnum: 22
FAX_GetSecurity	This method is called by the client to retrieve information regarding the fax server's security descriptor. Opnum: 23
FAX_SetSecurity	This method is called by the client to set the fax server's security descriptor. Opnum: 24
FAX_AccessCheck	This method is called by the client to check whether it has access permissions to do a particular server operation. Opnum: 25
FAX_CheckServerProtSeq	This method is called by the client to validate whether a specified protocol sequence is supported by the fax server. Opnum: 26
FAX_SendDocumentEx	This method is called by the client to send a specified fax job. Opnum: 27
FAX_EnumJobsEx	This method is called by the client to enumerate a specified set of jobs on the server's queue. Opnum: 28
FAX_GetJobEx	This method is called by the client to retrieve information regarding a specified job at the server. Opnum: 29
FAX_GetCountryList	This method is called by the client to retrieve the list of country/region information defined on the server. Opnum: 30
FAX_GetPersonalProfileInfo	This method is called by the client to retrieve information on the personal profile (section 3.1.1) of a user from the specified fax message present in the described message folder. Opnum: 31
FAX_GetQueueStates	This method is called by the client to retrieve the state of the fax queues at the server. Opnum: 32
FAX_SetQueue	This method is called by the client to change the state of the server queue. Opnum: 33
FAX_GetReceiptsConfiguration	This method is called by the client to obtain the receipts configuration information on the fax server. Opnum: 34
FAX_SetReceiptsConfiguration	This method is called by the client to set the receipt configuration information on the fax server. Opnum: 35
FAX_GetReceiptsOptions	This method is called by the client to the retrieve the supported receipt options on the fax server. Opnum: 36
FAX_GetVersion	This method is called by the client to get the version of the fax server it is connected to. Opnum: 37
FAX_GetOutboxConfiguration	This method is called by the client to retrieve the outbox configuration at the server. Opnum: 38
FAX_SetOutboxConfiguration	This method is called by the client to set the outbox configuration at the server. Opnum: 39
FAX_GetPersonalCoverPagesOption	This method is called by the client to retrieve information about the supported personal cover-page options. Opnum: 40
FAX_GetArchiveConfiguration	This method is called by the client to retrieve the archive configuration for a specific fax folder on the fax server. Opnum: 41
FAX_SetArchiveConfiguration	This method is called by the client to set the archive configuration for a specific fax folder on the fax server. Opnum: 42
FAX_GetActivityLoggingConfiguration	This method is called by the client to retrieve the current activity logging configuration. Opnum: 43
FAX_SetActivityLoggingConfiguration	This method is called by the client to set the activity logging configuration. Opnum: 44
FAX_EnumerateProviders	This method is called by the client to enumerate all the fax service providers (FSPs) that are installed on the server. Opnum: 45
FAX_GetPortEx	This method is called by the client to retrieve port status information for a specified port at the server. Opnum: 46
FAX_SetPortEx	This method is called by the fax client to set fax device information for a specified port at the server. Opnum: 47
FAX_EnumPortsEx	This method is called by the client to enumerate detailed port state information for each device connected to the fax server. Opnum: 48
FAX_GetExtensionData	This method is called by the client to retrieve the extension data for a device. Opnum: 49
FAX_SetExtensionData	This method is called by the client to write the extension data for a device. Opnum: 50
FAX_AddOutboundGroup	This method is called by the client to add a new outbound routing group on the fax server. Opnum: 51
FAX_SetOutboundGroup	This method is called by the client to set a new device list to an existing outbound routing group. Opnum: 52
FAX_RemoveOutboundGroup	This method is called by the client to remove an existing outbound routing group from the fax server. Opnum: 53
FAX_EnumOutboundGroups	This method is called by the client to enumerate the outbound routing groups on the fax server. Opnum: 54
FAX_SetDeviceOrderInGroup	This method is called by the client to set the order of a single device in a group of outbound routing devices. Opnum: 55
FAX_AddOutboundRule	This method is called by the client to add a new outbound routing rule. Opnum: 56
FAX_RemoveOutboundRule	This method is called by the client to remove an existing outbound routing rule. Opnum: 57
FAX_SetOutboundRule	This method is called by the client to set the information about an individual fax outbound routing rule. Opnum: 58
FAX_EnumOutboundRules	This method is called by the client to enumerate all the outbound routing rules that are present on the fax server. Opnum: 59
FAX_RegisterServiceProviderEx	This method is called by the client to register a fax service provider (FSP) with the fax service. Opnum: 60
FAX_UnregisterServiceProviderEx	This method is called by the client to unregister a fax service provider (FSP) from the fax service. Opnum: 61
FAX_UnregisterRoutingExtension	This method is called by the client to unregister an existing inbound routing extension. Opnum: 62
FAX_StartMessagesEnum	This method is called by the client to obtain a messages enumeration handle to start an enumeration of messages in one of the archives. Opnum: 63
FAX_EndMessagesEnum	This method is called by the client to end an enumeration of messages for a specified message enumeration handle. Opnum: 64
FAX_EnumMessages	This method is called by the client to obtain information about the messages by using a specified message enumeration handle. Opnum: 65
FAX_GetMessage	This method is called by the client to obtain the contents and size of a specified message. Opnum: 66
FAX_RemoveMessage	This method is called by the client to remove a message from a specific Fax Archive Folder. Opnum: 67
FAX_StartCopyToServer	This method is called by the client to obtain a copy handle to start copying a file to the server queue directory for which the client's fax user account has access to submit faxes. Opnum: 68
FAX_StartCopyMessageFromServer	This method is called by the client to obtain a copy handle to start copying a message from the server's archive or queue to the client. Opnum: 69
FAX_WriteFile	This method is called by the client to copy data (in chunks) to a file in the server queue directory by using a copy handle. Opnum: 70
FAX_ReadFile	This method is called by the client to copy data (in chunks) from a file on the server using a copy handle. Opnum: 71
FAX_EndCopy	This method is called by the client to end the copy process from or to the server for a specified copy handle. Opnum: 72
FAX_StartServerNotification	This method is called by the client to obtain a fax event handle to start receiving notifications about legacy fax events from the server. Opnum: 73
FAX_StartServerNotificationEx	This method is called by the client to obtain a fax event handle to start receiving notifications about extended or legacy fax events from the server. Opnum: 74
FAX_EndServerNotification	This method is called by the client to stop the notifications about fax events from the server for a specified fax event handle. Opnum: 75
FAX_GetServerActivity	This method is called by the client to retrieve the status of the fax queue activity and event log reports. Opnum: 76
FAX_SetConfigWizardUsed	This method is called by the client to set a value in the registry, indicating whether the configuration wizard was used. Opnum: 77
FAX_EnumRoutingExtensions	This method is called by the client to enumerate all the routing extensions that are registered with the fax server. Opnum: 78
Opnum79NotUsedOnWire	Reserved for local use. Opnum: 79
FAX_ConnectFaxServer	This method is called by the client to create an initial connection to the server. Opnum: 80
FAX_GetSecurityEx	This method is called by the client to retrieve information about the fax security descriptor from the fax server. Opnum: 81
FAX_RefreshArchive	This method is called by the client to notify the server that the archive folder has changed and SHOULD be refreshed. Opnum: 82
FAX_SetRecipientsLimit	This method is called by the client to set the recipients limit of a single broadcast job. Opnum: 83
FAX_GetRecipientsLimit	This method is called by the client to retrieve the recipients limit of a single broadcast job. Opnum: 84
FAX_GetServerSKU	This method is called by the client to retrieve the SKU of the fax server operating system. Opnum: 85
FAX_CheckValidFaxFolder	This method is called by the client to check whether the specified path is accessible to the fax server. Opnum: 86
FAX_GetJobEx2	This method is called by the client to retrieve information about a specified job. Opnum: 87
FAX_EnumJobsEx2	This method is called by the client to enumerate a specified set of jobs on the server's queue for a specific fax account. Opnum: 88
FAX_GetMessageEx	This method is called by the client to retrieve a particular message from one of the specified fax message archives. Opnum: 89
FAX_StartMessagesEnumEx	This method is called by the client to obtain a message enumeration handle to start an enumeration of messages in one of the archives. Opnum: 90
FAX_EnumMessagesEx	This method is called by the client to obtain information about the messages by using a specified message enumeration handle. Opnum: 91
FAX_StartServerNotificationEx2	This method is called by the client to obtain a fax event handle to start receiving notifications about extended fax events from the server. Opnum: 92
FAX_CreateAccount	This method is called by the client to create a new fax account on the server. Opnum: 93
FAX_DeleteAccount	This method is called by the client to delete a specified fax account from the server. Opnum: 94
FAX_EnumAccounts	This method is called by the client to enumerate all the fax accounts on the server. Opnum: 95
FAX_GetAccountInfo	This method is called by the client to retrieve information about a specified account. Opnum: 96
FAX_GetGeneralConfiguration	This method is called by the client to retrieve information regarding the general configuration at the server. Opnum: 97
FAX_SetGeneralConfiguration	This method is called by the client to set the general configuration options for the server. Opnum: 98
FAX_GetSecurityEx2	This method is called by the client to retrieve information about the fax security descriptor from the fax server. Opnum: 99
FAX_SetSecurityEx2	This method is called by the client to set the security descriptor of the fax server. Opnum: 100
FAX_AccessCheckEx2	This method is called by the client to check whether it has access permissions for a particular server operation. Opnum: 101
FAX_ReAssignMessage	This method is called by the client to assign the specified fax message to a set of users. Opnum: 102
FAX_SetMessage	This method is called by the client to set message properties for a specified message. Opnum: 103
FAX_GetConfigOption	This method is called by the client to retrieve a configuration setting at the server. Opnum: 104

In the table above, the term "Reserved for local use" means that the client MUST NOT send the opnum. The server behavior is undefined.<63>

All methods MUST NOT throw exceptions except those that are thrown by the underlying RPC protocol [MS-RPCE].