3.1.4.2 FaxObs Server Interface

This protocol MUST indicate to the RPC runtime that it is to perform a strict NDR data consistency check at target level 5.0, as specified in [MS-RPCE] section 3.

This protocol MUST indicate to the RPC runtime via the strict_context_handle attribute that it is to reject the use of context handles created by a method of a different RPC interface than this one, as specified in section 3 of [MS-RPCE].

Methods in RPC Opnum Order

Method

Description

FaxObs_ConnectionRefCount

Called by the client to connect or disconnect from the server.

Opnum: 0

FaxObs_GetVersion

Called by the client to obtain the version number of the server.

Opnum: 1

FaxObs_GetInstallType

Called by the client to obtain information about the fax server installation.

Opnum: 2

FaxObs_OpenPort

Called by the client to open a fax port and obtain a fax port handle.

Opnum: 3

FaxObs_ClosePort

Called by the client to close a fax port and release the fax port handle obtained with a FaxObs_OpenPort (section 3.1.4.2.5) call.

Opnum: 4

FaxObs_SendDocument

Called by the client to send a fax document.

Opnum: 5

FaxObs_GetQueueFileName

Called by the client to obtain from the server the name of a new file located in the fax server queue directory. The fax client can copy to this file fax data to be transmitted and submit the file name to FaxObs_SendDocument (section 3.1.4.2.7).

Opnum: 6

FaxObs_EnumJobs

Called by the client to enumerate the fax jobs on the server.

Opnum: 7

FaxObs_GetJob

Called by the client to retrieve information regarding a specific fax job.

Opnum: 8

FaxObs_SetJob

Called by the client to request a command to pause, resume, or cancel a fax job.

Opnum: 9

FaxObs_GetPageData

Called by the client to retrieve the data from the first page of an outgoing fax job.

Opnum: 10

FaxObs_GetDeviceStatus

Called by the client to retrieve information about a specified fax device (port).

Opnum: 11

FaxObs_Abort

Called by the client to abort the specified fax job on the server.

Opnum: 12

FaxObs_EnumPorts

Called by the client to enumerate the fax ports (devices) on the server and retrieve information describing these ports (devices).

Opnum: 13

FaxObs_GetPort

Called by the client to retrieve status information from the server about the specified fax port (device).

Opnum: 14

FaxObs_SetPort

Called by the client to change the configuration of a fax port (device).

Opnum: 15

FaxObs_EnumRoutingMethods

Called by the client to enumerate all routing methods that are registered with the server for a specified fax port (device).

Opnum: 16

FaxObs_EnableRoutingMethod

Called by the client to enable or disable a routing method for a fax port (device).

Opnum: 17

FaxObs_GetRoutingInfo

Called by the client to retrieve information about a fax routing method.

Opnum: 18

FaxObs_SetRoutingInfo

Called by the client to set routing information for a fax routing method.

Opnum: 19

FaxObs_EnumGlobalRoutingInfo

Called by the client to enumerate global routing information from the server.

Opnum: 20

FaxObs_SetGlobalRoutingInfo

Called by the client to set global routing properties such as the routing method priority.

Opnum: 21

FaxObs_GetConfiguration

Called by the client to retrieve information about the fax server configuration.

Opnum: 22

FaxObs_SetConfiguration

Called by the client to change the fax server configuration.

Opnum: 23

FaxObs_GetLoggingCategories

Called by the client to retrieve the current fax logging categories from the server,

Opnum: 24

FaxObs_SetLoggingCategories

Called by the client to set the current fax logging categories on the server.

Opnum: 25

FaxObs_GetTapiLocations

Called by the client to retrieve the current and other available TAPI locations configured for the server.

Opnum: 26

FaxObs_SetTapiLocations

Called by the client to set the current and other available TAPI locations for the server.

Opnum: 27

FaxObs_GetMapiProfiles

Called by the client to retrieve the names of the current MAPI profiles from the server.

Opnum: 28

FaxObs_StartClientServer

Called by the client to register to receive notifications of fax events from the server,

Opnum: 29

Opnum30NotUsedOnWire

Reserved for local use.

Opnum: 30

FaxObs_GetSecurityDescriptor

Called by the client to retrieve the fax security descriptor of the server.

Opnum: 31

FaxObs_SetSecurityDescriptor

Called by the client to set the fax security descriptor of the server.

Opnum: 32

FaxObs_GetSecurityDescriptorCount

Called by the client to retrieve the total number of fax security descriptors from the server.

Opnum: 33

FaxObs_AccessCheck

Called by the client to check whether the currently logged on client user account has access permissions top execute specific fax operations on the server.

Opnum: 34

In the table above, the term "Reserved for local use" means that the client MUST NOT send the opnum, and the server behavior is undefined because it does not affect interoperability.<182>

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