Documentation
¶
Index ¶
- Variables
- func FaxobsServerHandle(ctx context.Context, o FaxobsServer, opNum int, r ndr.Reader) (dcerpc.Operation, error)
- func NewFaxobsServerHandle(o FaxobsServer) dcerpc.ServerHandle
- func RegisterFaxobsServer(conn dcerpc.Conn, o FaxobsServer, opts ...dcerpc.Option)
- type AbortRequest
- type AbortResponse
- type AccessCheckRequest
- type AccessCheckResponse
- type ClosePortRequest
- type ClosePortResponse
- type ConnectionReferenceCountRequest
- type ConnectionReferenceCountResponse
- type EnableRoutingMethodRequest
- type EnableRoutingMethodResponse
- type EnumGlobalRoutingInfoRequest
- type EnumGlobalRoutingInfoResponse
- type EnumJobsRequest
- type EnumJobsResponse
- type EnumPortsRequest
- type EnumPortsResponse
- type EnumRoutingMethodsRequest
- type EnumRoutingMethodsResponse
- type FaxobsClient
- type FaxobsServer
- type GetConfigurationRequest
- type GetConfigurationResponse
- type GetDeviceStatusRequest
- type GetDeviceStatusResponse
- type GetInstallTypeRequest
- type GetInstallTypeResponse
- type GetJobRequest
- type GetJobResponse
- type GetLoggingCategoriesRequest
- type GetLoggingCategoriesResponse
- type GetMAPIProfilesRequest
- type GetMAPIProfilesResponse
- type GetPageDataRequest
- type GetPageDataResponse
- type GetPortRequest
- type GetPortResponse
- type GetQueueFileNameRequest
- type GetQueueFileNameResponse
- type GetRoutingInfoRequest
- type GetRoutingInfoResponse
- type GetSecurityDescriptorCountRequest
- type GetSecurityDescriptorCountResponse
- type GetSecurityDescriptorRequest
- type GetSecurityDescriptorResponse
- type GetTAPILocationsRequest
- type GetTAPILocationsResponse
- type GetVersionRequest
- type GetVersionResponse
- type OpenPortRequest
- type OpenPortResponse
- type SendDocumentRequest
- type SendDocumentResponse
- type SetConfigurationRequest
- type SetConfigurationResponse
- type SetGlobalRoutingInfoRequest
- type SetGlobalRoutingInfoResponse
- type SetJobRequest
- type SetJobResponse
- type SetLoggingCategoriesRequest
- type SetLoggingCategoriesResponse
- type SetPortRequest
- type SetPortResponse
- type SetRoutingInfoRequest
- type SetRoutingInfoResponse
- type SetSecurityDescriptorRequest
- type SetSecurityDescriptorResponse
- type SetTAPILocationsRequest
- type SetTAPILocationsResponse
- type StartClientServerRequest
- type StartClientServerResponse
Constants ¶
This section is empty.
Variables ¶
View Source
var ( // Syntax UUID FaxobsSyntaxUUID = &uuid.UUID{TimeLow: 0xea0a3165, TimeMid: 0x4834, TimeHiAndVersion: 0x11d2, ClockSeqHiAndReserved: 0xa6, ClockSeqLow: 0xf8, Node: [6]uint8{0x0, 0xc0, 0x4f, 0xa3, 0x46, 0xcc}} // Syntax ID FaxobsSyntaxV4_0 = &dcerpc.SyntaxID{IfUUID: FaxobsSyntaxUUID, IfVersionMajor: 4, IfVersionMinor: 0} )
View Source
var (
// import guard
GoPackage = "fax"
)
Functions ¶
func FaxobsServerHandle ¶
func NewFaxobsServerHandle ¶
func NewFaxobsServerHandle(o FaxobsServer) dcerpc.ServerHandle
func RegisterFaxobsServer ¶
func RegisterFaxobsServer(conn dcerpc.Conn, o FaxobsServer, opts ...dcerpc.Option)
Types ¶
type AbortRequest ¶
type AbortRequest struct {
// JobId: A DWORD ([MS-DTYP] section 2.2.9) containing a unique number that identifies
// the fax job to terminate.
JobID uint32 `idl:"name:JobId" json:"job_id"`
}
AbortRequest structure represents the FaxObs_Abort operation request
func (*AbortRequest) MarshalNDR ¶
func (*AbortRequest) UnmarshalNDR ¶
type AbortResponse ¶
type AbortResponse struct {
// Return: The FaxObs_Abort return value.
Return uint32 `idl:"name:Return" json:"return"`
}
AbortResponse structure represents the FaxObs_Abort operation response
func (*AbortResponse) MarshalNDR ¶
func (*AbortResponse) UnmarshalNDR ¶
type AccessCheckRequest ¶
type AccessCheckRequest struct {
// AccessMask: A DWORD ([MS-DTYP] section 2.2.9) containing a set of bit flags that
// define the fax access permissions to check for the fax client user account. This
// parameter MUST be a bitwise OR combination of generic FaxObs access rights and specific
// FaxObs access rights that are described in the following tables.
//
// +------------------------------+----------------------------------------------------------------------------------+
// | GENERIC FAXOBS ACCESS | |
// | RIGHTS | DESCRIPTION |
// | | |
// +------------------------------+----------------------------------------------------------------------------------+
// +------------------------------+----------------------------------------------------------------------------------+
// | FAX_WRITE 0x00020001 | Includes the read-only rights that are granted by the following specific |
// | | FaxObs access rights in combination with the standard access rights |
// | | STANDARD_RIGHTS_WRITE: § FAX_JOB_SUBMIT |
// +------------------------------+----------------------------------------------------------------------------------+
// | FAX_READ 0x00020016 | Includes the read-only rights that are granted by the following specific |
// | | FaxObs access rights in combination with the standard access rights |
// | | STANDARD_RIGHTS_READ: § FAX_JOB_QUERY § FAX_CONFIG_QUERY § FAX_PORT_QUERY |
// +------------------------------+----------------------------------------------------------------------------------+
// | FAX_ALL_ACCESS 0x001F007F | Includes the read-only rights that are granted by the following specific |
// | | FaxObs access rights in combination with the standard access rights |
// | | STANDARD_RIGHTS_ALL: § FAX_JOB_SUBMIT § FAX_JOB_QUERY § FAX_CONFIG_QUERY § |
// | | FAX_CONFIG_SET § FAX_PORT_QUERY § FAX_PORT_SET § FAX_JOB_MANAGE |
// +------------------------------+----------------------------------------------------------------------------------+
//
// The generic FaxObs access rights are bitwise OR combination of specific FaxObs access
// rights and standard access rights. For more information about the standard access
// rights, see [MSDN-SAR].
//
// +-------------------------------+----------------------------------------------------------------------------------+
// | SPECIFIC FAXOBS ACCESS | |
// | RIGHTS | DESCRIPTION |
// | | |
// +-------------------------------+----------------------------------------------------------------------------------+
// +-------------------------------+----------------------------------------------------------------------------------+
// | FAX_JOB_SUBMIT 0x00000001 | The user can submit documents to be faxed. Example method: FaxObs_SendDocument |
// | | (section 3.1.4.2.7). |
// +-------------------------------+----------------------------------------------------------------------------------+
// | FAX_JOB_QUERY 0x00000002 | The user can query information about submitted fax jobs. Example method: |
// | | FaxObs_EnumJobs (section 3.1.4.2.9). |
// +-------------------------------+----------------------------------------------------------------------------------+
// | FAX_CONFIG_QUERY 0x00000004 | The user can query the fax server configuration. Example method: |
// | | FaxObs_GetConfiguration (section 3.1.4.2.24). |
// +-------------------------------+----------------------------------------------------------------------------------+
// | FAX_CONFIG_SET 0x00000008 | The user can change the fax server configuration. Example method: |
// | | FaxObs_SetConfiguration (section 3.1.4.2.25). |
// +-------------------------------+----------------------------------------------------------------------------------+
// | FAX_PORT_QUERY 0x00000010 | The user can query information about the fax ports (devices) installed on the |
// | | fax server. Example method: FaxObs_EnumPorts (section 3.1.4.2.15). |
// +-------------------------------+----------------------------------------------------------------------------------+
// | FAX_PORT_SET 0x00000020 | The user can change the configuration of the fax ports (devices) installed on |
// | | the fax server. Example method: FaxObs_SetPort (section 3.1.4.2.17). |
// +-------------------------------+----------------------------------------------------------------------------------+
// | FAX_JOB_MANAGE 0x00000040 | The user can pause, resume, and cancel submitted fax jobs. Example method: |
// | | FaxObs_SetJob (section 3.1.4.2.11). |
// +-------------------------------+----------------------------------------------------------------------------------+
AccessMask uint32 `idl:"name:AccessMask" json:"access_mask"`
}
AccessCheckRequest structure represents the FaxObs_AccessCheck operation request
func (*AccessCheckRequest) MarshalNDR ¶
func (*AccessCheckRequest) UnmarshalNDR ¶
type AccessCheckResponse ¶
type AccessCheckResponse struct {
// fAccess: A pointer to a BOOL variable to receive on successful return the access
// check return value. A TRUE value indicates that access is allowed. A FALSE value
// indicates that access is denied.
Access uint32 `idl:"name:fAccess" json:"access"`
// Return: The FaxObs_AccessCheck return value.
Return uint32 `idl:"name:Return" json:"return"`
}
AccessCheckResponse structure represents the FaxObs_AccessCheck operation response
func (*AccessCheckResponse) MarshalNDR ¶
func (*AccessCheckResponse) UnmarshalNDR ¶
type ClosePortRequest ¶
type ClosePortRequest struct {
// FaxPortHandle: A pointer to a fax port handle obtained with a FaxObs_OpenPort call.
FaxPort *fax.Port `idl:"name:FaxPortHandle" json:"fax_port"`
}
ClosePortRequest structure represents the FaxObs_ClosePort operation request
func (*ClosePortRequest) MarshalNDR ¶
func (*ClosePortRequest) UnmarshalNDR ¶
type ClosePortResponse ¶
type ClosePortResponse struct {
// FaxPortHandle: A pointer to a fax port handle obtained with a FaxObs_OpenPort call.
FaxPort *fax.Port `idl:"name:FaxPortHandle" json:"fax_port"`
// Return: The FaxObs_ClosePort return value.
Return uint32 `idl:"name:Return" json:"return"`
}
ClosePortResponse structure represents the FaxObs_ClosePort operation response
func (*ClosePortResponse) MarshalNDR ¶
func (*ClosePortResponse) UnmarshalNDR ¶
type ConnectionReferenceCountRequest ¶
type ConnectionReferenceCountRequest struct {
// Handle: The connection handle that references a connection between the client and
// the server. If Connect is set to 0x00000001 (Connect), a new handle is returned in
// this parameter. Otherwise, this parameter MUST be set to a handle returned from a
// previous call to this method.
Handle *fax.Service `idl:"name:Handle" json:"handle"`
// Connect: A DWORD ([MS-DTYP] section 2.2.9) value that specifies connection information.
//
// +-----------------------+----------------------------------------------------------------------------------+
// | | |
// | VALUE/CODE | MEANING |
// | | |
// +-----------------------+----------------------------------------------------------------------------------+
// +-----------------------+----------------------------------------------------------------------------------+
// | Disconnect 0x00000000 | Close the Fax Server connection. The handle specified in Handle MUST have been |
// | | returned by a previous call to FaxObs_ConnectionRefCount with a Connect value of |
// | | 0x00000001 (Connect). After this call, the handle in Handle will be invalid and |
// | | MUST NOT be used in any subsequent calls. |
// +-----------------------+----------------------------------------------------------------------------------+
// | Connect 0x00000001 | Connect to the Fax Server. |
// +-----------------------+----------------------------------------------------------------------------------+
Connect uint32 `idl:"name:Connect" json:"connect"`
}
ConnectionReferenceCountRequest structure represents the FaxObs_ConnectionRefCount operation request
func (*ConnectionReferenceCountRequest) MarshalNDR ¶
func (*ConnectionReferenceCountRequest) UnmarshalNDR ¶
type ConnectionReferenceCountResponse ¶
type ConnectionReferenceCountResponse struct {
// Handle: The connection handle that references a connection between the client and
// the server. If Connect is set to 0x00000001 (Connect), a new handle is returned in
// this parameter. Otherwise, this parameter MUST be set to a handle returned from a
// previous call to this method.
Handle *fax.Service `idl:"name:Handle" json:"handle"`
// parameter if the fax print queues can be shared as described in section 3.1.1, and
// a zero value otherwise.<183>
CanShare uint32 `idl:"name:CanShare" json:"can_share"`
// Return: The FaxObs_ConnectionRefCount return value.
Return uint32 `idl:"name:Return" json:"return"`
}
ConnectionReferenceCountResponse structure represents the FaxObs_ConnectionRefCount operation response
func (*ConnectionReferenceCountResponse) MarshalNDR ¶
func (*ConnectionReferenceCountResponse) UnmarshalNDR ¶
type EnableRoutingMethodRequest ¶
type EnableRoutingMethodRequest struct {
// FaxPortHandle: An RPC context handle that references a fax port.
FaxPort *fax.Port `idl:"name:FaxPortHandle" json:"fax_port"`
// RoutingGuid: A curly braced GUID string that uniquely identifies the fax routing
// method on which to act. For more information about routing methods, see [MSDN-FRM].
// The routing methods and their curly braced GUID string values that can be used for
// this parameter are discoverable by calling FaxObs_EnumRoutingMethods (section 3.1.4.2.18).
// Included in this list are the default routing methods described in section 2.2.87.
RoutingGUID string `idl:"name:RoutingGuid;string;pointer:unique" json:"routing_guid"`
// Enabled: A Boolean variable that indicates whether the client request is to enable
// (when set to TRUE) or disable (when set to FALSE) the fax routing method specified
// by RoutingGuid.
Enabled bool `idl:"name:Enabled" json:"enabled"`
}
EnableRoutingMethodRequest structure represents the FaxObs_EnableRoutingMethod operation request
func (*EnableRoutingMethodRequest) MarshalNDR ¶
func (*EnableRoutingMethodRequest) UnmarshalNDR ¶
type EnableRoutingMethodResponse ¶
type EnableRoutingMethodResponse struct {
// Return: The FaxObs_EnableRoutingMethod return value.
Return uint32 `idl:"name:Return" json:"return"`
}
EnableRoutingMethodResponse structure represents the FaxObs_EnableRoutingMethod operation response
func (*EnableRoutingMethodResponse) MarshalNDR ¶
func (*EnableRoutingMethodResponse) UnmarshalNDR ¶
type EnumGlobalRoutingInfoRequest ¶
type EnumGlobalRoutingInfoRequest struct {
// RoutingInfoBuffer: A pointer to the address of the returned buffer containing an
// array of _FAX_GLOBAL_ROUTING_INFOW (section 2.2.33) structures. Each structure contains
// information about one fax routing method, as it pertains to the entire fax server.
RoutingInfoBuffer []byte `idl:"name:RoutingInfoBuffer;size_is:(, RoutingInfoBufferSize);pointer:unique" json:"routing_info_buffer"`
// RoutingInfoBufferSize: A variable to return the size, in bytes, of the routing information
// buffer.
RoutingInfoBufferSize uint32 `idl:"name:RoutingInfoBufferSize" json:"routing_info_buffer_size"`
}
EnumGlobalRoutingInfoRequest structure represents the FaxObs_EnumGlobalRoutingInfo operation request
func (*EnumGlobalRoutingInfoRequest) MarshalNDR ¶
func (*EnumGlobalRoutingInfoRequest) UnmarshalNDR ¶
type EnumGlobalRoutingInfoResponse ¶
type EnumGlobalRoutingInfoResponse struct {
// RoutingInfoBuffer: A pointer to the address of the returned buffer containing an
// array of _FAX_GLOBAL_ROUTING_INFOW (section 2.2.33) structures. Each structure contains
// information about one fax routing method, as it pertains to the entire fax server.
RoutingInfoBuffer []byte `idl:"name:RoutingInfoBuffer;size_is:(, RoutingInfoBufferSize);pointer:unique" json:"routing_info_buffer"`
// RoutingInfoBufferSize: A variable to return the size, in bytes, of the routing information
// buffer.
RoutingInfoBufferSize uint32 `idl:"name:RoutingInfoBufferSize" json:"routing_info_buffer_size"`
// MethodsReturned: A pointer to a DWORD ([MS-DTYP] section 2.2.9) variable to receive
// the number of _FAX_GLOBAL_ROUTING_INFOW structures that the method returns in the
// RoutingInfoBuffer parameter. This number SHOULD equal the total number of fax routing
// methods installed on the fax server.
MethodsReturned uint32 `idl:"name:MethodsReturned" json:"methods_returned"`
// Return: The FaxObs_EnumGlobalRoutingInfo return value.
Return uint32 `idl:"name:Return" json:"return"`
}
EnumGlobalRoutingInfoResponse structure represents the FaxObs_EnumGlobalRoutingInfo operation response
func (*EnumGlobalRoutingInfoResponse) MarshalNDR ¶
func (*EnumGlobalRoutingInfoResponse) UnmarshalNDR ¶
type EnumJobsRequest ¶
type EnumJobsRequest struct {
// Buffer: A pointer to the address of the returned buffer containing an array of _FAX_JOB_ENTRY
// (section 2.2.6) structures.
Buffer []byte `idl:"name:Buffer;size_is:(, BufferSize);pointer:unique" json:"buffer"`
// BufferSize: A variable to return the size, in bytes, of the job information buffer.
BufferSize uint32 `idl:"name:BufferSize" json:"buffer_size"`
}
EnumJobsRequest structure represents the FaxObs_EnumJobs operation request
func (*EnumJobsRequest) MarshalNDR ¶
func (*EnumJobsRequest) UnmarshalNDR ¶
type EnumJobsResponse ¶
type EnumJobsResponse struct {
// Buffer: A pointer to the address of the returned buffer containing an array of _FAX_JOB_ENTRY
// (section 2.2.6) structures.
Buffer []byte `idl:"name:Buffer;size_is:(, BufferSize);pointer:unique" json:"buffer"`
// BufferSize: A variable to return the size, in bytes, of the job information buffer.
BufferSize uint32 `idl:"name:BufferSize" json:"buffer_size"`
// JobsReturned: A pointer to a DWORD ([MS-DTYP] section 2.2.9) variable to receive
// the number of _FAX_JOB_ENTRY structures that the method returns in Buffer.
JobsReturned uint32 `idl:"name:JobsReturned" json:"jobs_returned"`
// Return: The FaxObs_EnumJobs return value.
Return uint32 `idl:"name:Return" json:"return"`
}
EnumJobsResponse structure represents the FaxObs_EnumJobs operation response
func (*EnumJobsResponse) MarshalNDR ¶
func (*EnumJobsResponse) UnmarshalNDR ¶
type EnumPortsRequest ¶
type EnumPortsRequest struct {
// PortBuffer: A pointer to the address of the returned buffer containing an array of
// _FAX_PORT_INFO (section 2.2.8) structures. Each structure describes one fax port
// (device).
PortBuffer []byte `idl:"name:PortBuffer;size_is:(, BufferSize);pointer:unique" json:"port_buffer"`
// BufferSize: A variable to return the size, in bytes, of the PortBuffer.
BufferSize uint32 `idl:"name:BufferSize" json:"buffer_size"`
}
EnumPortsRequest structure represents the FaxObs_EnumPorts operation request
func (*EnumPortsRequest) MarshalNDR ¶
func (*EnumPortsRequest) UnmarshalNDR ¶
type EnumPortsResponse ¶
type EnumPortsResponse struct {
// PortBuffer: A pointer to the address of the returned buffer containing an array of
// _FAX_PORT_INFO (section 2.2.8) structures. Each structure describes one fax port
// (device).
PortBuffer []byte `idl:"name:PortBuffer;size_is:(, BufferSize);pointer:unique" json:"port_buffer"`
// BufferSize: A variable to return the size, in bytes, of the PortBuffer.
BufferSize uint32 `idl:"name:BufferSize" json:"buffer_size"`
// PortsReturned: A pointer to a DWORD ([MS-DTYP] section 2.2.9) variable to receive
// the number of _FAX_PORT_INFO that the method returns in the PortBuffer parameter.
PortsReturned uint32 `idl:"name:PortsReturned" json:"ports_returned"`
// Return: The FaxObs_EnumPorts return value.
Return uint32 `idl:"name:Return" json:"return"`
}
EnumPortsResponse structure represents the FaxObs_EnumPorts operation response
func (*EnumPortsResponse) MarshalNDR ¶
func (*EnumPortsResponse) UnmarshalNDR ¶
type EnumRoutingMethodsRequest ¶
type EnumRoutingMethodsRequest struct {
// FaxPortHandle: An RPC context handle that references a fax port.
FaxPort *fax.Port `idl:"name:FaxPortHandle" json:"fax_port"`
// RoutingInfoBuffer: A pointer to the address of the returned buffer containing an
// array of FAX_ROUTING_METHOD (section 2.2.9) structures. Each structure contains information
// about one fax routing method.
RoutingInfoBuffer []byte `idl:"name:RoutingInfoBuffer;size_is:(, RoutingInfoBufferSize);pointer:unique" json:"routing_info_buffer"`
// RoutingInfoBufferSize: A variable to return the size, in bytes, of the routing method
// buffer.
RoutingInfoBufferSize uint32 `idl:"name:RoutingInfoBufferSize" json:"routing_info_buffer_size"`
}
EnumRoutingMethodsRequest structure represents the FaxObs_EnumRoutingMethods operation request
func (*EnumRoutingMethodsRequest) MarshalNDR ¶
func (*EnumRoutingMethodsRequest) UnmarshalNDR ¶
type EnumRoutingMethodsResponse ¶
type EnumRoutingMethodsResponse struct {
// RoutingInfoBuffer: A pointer to the address of the returned buffer containing an
// array of FAX_ROUTING_METHOD (section 2.2.9) structures. Each structure contains information
// about one fax routing method.
RoutingInfoBuffer []byte `idl:"name:RoutingInfoBuffer;size_is:(, RoutingInfoBufferSize);pointer:unique" json:"routing_info_buffer"`
// RoutingInfoBufferSize: A variable to return the size, in bytes, of the routing method
// buffer.
RoutingInfoBufferSize uint32 `idl:"name:RoutingInfoBufferSize" json:"routing_info_buffer_size"`
// PortsReturned: A pointer to a DWORD ([MS-DTYP] section 2.2.9) variable to receive
// the number of FAX_ROUTING_METHOD that are returned by the RoutingInfoBuffer parameter.
PortsReturned uint32 `idl:"name:PortsReturned" json:"ports_returned"`
// Return: The FaxObs_EnumRoutingMethods return value.
Return uint32 `idl:"name:Return" json:"return"`
}
EnumRoutingMethodsResponse structure represents the FaxObs_EnumRoutingMethods operation response
func (*EnumRoutingMethodsResponse) MarshalNDR ¶
func (*EnumRoutingMethodsResponse) UnmarshalNDR ¶
type FaxobsClient ¶
type FaxobsClient interface {
// The FaxObs_ConnectionRefCount (Opnum 0) method is called by the client to connect
// to or disconnect from the server.
//
// Return Values: This method MUST return 0x00000000 (ERROR_SUCCESS) for success; otherwise,
// it MUST return one of the fax-specific errors that are defined in section 2.2.52
// or one of the other standard errors defined in [MS-ERREF] section 2.2. There are
// no predefined specific error codes to be returned by this method.
//
// Exceptions Thrown: No exceptions are thrown except those that are thrown by the underlying
// RPC protocol, [MS-RPCE].
ConnectionReferenceCount(context.Context, *ConnectionReferenceCountRequest, ...dcerpc.CallOption) (*ConnectionReferenceCountResponse, error)
// The client calls the FaxObs_GetVersion (Opnum 1) method to obtain the version number
// of the server.
//
// Return Values: This method MUST return 0x00000000 (ERROR_SUCCESS) for success; otherwise,
// it MUST return the following error code, one of the fax-specific errors that are
// defined in section 2.2.52, or one of the other standard errors defined in [MS-ERREF]
// section 2.2.
//
// +------------------------------------+------------------------------------------------------------+
// | RETURN | |
// | VALUE/CODE | DESCRIPTION |
// | | |
// +------------------------------------+------------------------------------------------------------+
// +------------------------------------+------------------------------------------------------------+
// | ERROR_INVALID_PARAMETER 0x00000057 | The Version parameter is set to a NULL pointer value.<184> |
// +------------------------------------+------------------------------------------------------------+
//
// Exceptions Thrown: No exceptions are thrown except those that are thrown by the underlying
// RPC protocol, [MS-RPCE].
GetVersion(context.Context, *GetVersionRequest, ...dcerpc.CallOption) (*GetVersionResponse, error)
// The client calls the FaxObs_GetInstallType (Opnum 2) method to obtain information
// about the server installation.
//
// Return Values: This method MUST return 0x00000000 (ERROR_SUCCESS) for success; otherwise,
// it MUST return the following error code, one of the fax-specific errors that are
// defined in section 2.2.52, or one of the other standard errors defined in [MS-ERREF]
// section 2.2.
//
// +-----------------------------------+------------------------------------------------------------------------------+
// | RETURN | |
// | VALUE/CODE | DESCRIPTION |
// | | |
// +-----------------------------------+------------------------------------------------------------------------------+
// +-----------------------------------+------------------------------------------------------------------------------+
// | ERROR_INVALID_FUNCTION 0x00000001 | The fax server is unable to retrieve the requested installation information. |
// +-----------------------------------+------------------------------------------------------------------------------+
//
// Exceptions Thrown: No exceptions are thrown except those that are thrown by the underlying
// RPC protocol, [MS-RPCE].
GetInstallType(context.Context, *GetInstallTypeRequest, ...dcerpc.CallOption) (*GetInstallTypeResponse, error)
// The client calls the FaxObs_OpenPort (Opnum 3) method to open a fax port and obtain
// a fax port handle.
//
// Return Values: This method MUST return 0x00000000 (ERROR_SUCCESS) for success; otherwise,
// it MUST return one of the following error codes, one of the fax-specific errors that
// are defined in section 2.2.52, or one of the other standard errors defined in [MS-ERREF]
// section 2.2.
//
// +------------------------------------+----------------------------------------------------------------------------------+
// | RETURN | |
// | VALUE/CODE | DESCRIPTION |
// | | |
// +------------------------------------+----------------------------------------------------------------------------------+
// +------------------------------------+----------------------------------------------------------------------------------+
// | ERROR_ACCESS_DENIED 0x00000005 | Access is denied. The caller does not have the FAX_PORT_QUERY access rights |
// | | required for this operation. |
// +------------------------------------+----------------------------------------------------------------------------------+
// | ERROR_INVALID_HANDLE 0x00000006 | The call was made with the Flags parameter containing the PORT_OPEN_MODIFY flag, |
// | | and the port is already opened to be modified by another call. |
// +------------------------------------+----------------------------------------------------------------------------------+
// | ERROR_BAD_UNIT 0x00000014 | The system cannot find the port for the receiving device by using the line |
// | | identifier specified by the DeviceId parameter. |
// +------------------------------------+----------------------------------------------------------------------------------+
// | ERROR_INVALID_PARAMETER 0x00000057 | The FaxPortHandle parameter is set to a NULL pointer value.<188> |
// +------------------------------------+----------------------------------------------------------------------------------+
//
// Exceptions Thrown: No exceptions are thrown except those that are thrown by the underlying
// RPC protocol, [MS-RPCE].
OpenPort(context.Context, *OpenPortRequest, ...dcerpc.CallOption) (*OpenPortResponse, error)
// The client calls the FaxObs_ClosePort (Opnum 4) method to close a fax port and release
// the fax port handle obtained with a FaxObs_OpenPort (section 3.1.4.2.5) call.
//
// On success, the server MUST close the specified port and release the handle.
//
// Return Values: This method MUST return 0x00000000 (ERROR_SUCCESS) for success; otherwise,
// it MUST return the following error code, one of the fax-specific errors that are
// defined in section 2.2.52, or one of the other standard errors defined in [MS-ERREF]
// section 2.2.
//
// +--------------------------------+----------------------------------------------------------------------------------+
// | RETURN | |
// | VALUE/CODE | DESCRIPTION |
// | | |
// +--------------------------------+----------------------------------------------------------------------------------+
// +--------------------------------+----------------------------------------------------------------------------------+
// | ERROR_ACCESS_DENIED 0x00000005 | Access is denied. The client's fax user account does not have the FAX_PORT_QUERY |
// | | access rights required for this operation. |
// +--------------------------------+----------------------------------------------------------------------------------+
//
// Exceptions Thrown: No exceptions are thrown except those that are thrown by the underlying
// RPC protocol, [MS-RPCE].
ClosePort(context.Context, *ClosePortRequest, ...dcerpc.CallOption) (*ClosePortResponse, error)
// The client calls the FaxObs_SendDocument (Opnum 5) method to send a document.
//
// Return Values: This method MUST return 0x00000000 (ERROR_SUCCESS) for success; otherwise,
// it MUST return one of the following error codes, one of the fax-specific errors that
// are defined in section 2.2.52, or one of the other standard errors defined in [MS-ERREF]
// section 2.2.
//
// +------------------------------------+----------------------------------------------------------------------------------+
// | RETURN | |
// | VALUE/CODE | DESCRIPTION |
// | | |
// +------------------------------------+----------------------------------------------------------------------------------+
// +------------------------------------+----------------------------------------------------------------------------------+
// | ERROR_ACCESS_DENIED 0x00000005 | Access is denied. The client's fax user account does not have the FAX_JOB_SUBMIT |
// | | access rights required for this operation. |
// +------------------------------------+----------------------------------------------------------------------------------+
// | ERROR_INVALID_PARAMETER 0x00000057 | The parameter is incorrect. This error code is returned under any of the |
// | | following conditions: § The JobParams parameter is set to a NULL pointer |
// | | value. § The FileName parameter is set to a NULL pointer value. § The FaxJobId |
// | | parameter is set to a NULL pointer value.<190> § The length of the character |
// | | string specified by the FileName parameter (excluding the length of the |
// | | terminating null character) plus the length of the fax queue directory path name |
// | | (excluding the length of the terminating null character) exceeds 253 characters. |
// | | This error can occur if the fax client is not using a file path name obtained |
// | | from FaxObs_GetQueueFileName. § Either of the following conditions are true: § |
// | | The first value of the Reserved field of the structure referenced by JobParams |
// | | is set to 0xFFFFFFFE (32-bit) or 0x00000000FFFFFFFE (64-bit). The second value |
// | | of this same Reserved field is set to 0x00000002 (32-bit) or 0x0000000000000002 |
// | | (64-bit). The RecipientNumber field of the same structure is set to NULL. § The |
// | | first value of the Reserved field of the structure referenced by JobParams is |
// | | not set to 0xFFFFFFFE (32-bit) or 0x00000000FFFFFFFE (64-bit). The CallHandle |
// | | field of the same structure is not set to 0x00000000. The RecipientNumber field |
// | | of the JobParams structure is NULL. |
// +------------------------------------+----------------------------------------------------------------------------------+
//
// Exceptions Thrown: No exceptions are thrown except those that are thrown by the underlying
// RPC protocol, [MS-RPCE].
SendDocument(context.Context, *SendDocumentRequest, ...dcerpc.CallOption) (*SendDocumentResponse, error)
// The client calls FaxObs_GetQueueFileName (Opnum 6) to obtain from the server the
// name of a new file located in the fax server queue directory. The client can copy
// to this file the fax data to be transmitted and submit the file name to FaxObs_SendDocument
// (section 3.1.4.2.7).
//
// The client SHOULD set the FileNameSize parameter to a value of 255 characters. If
// the client sets FileNameSize to a value exceeding 255 characters, the server SHOULD
// NOT write more than 255 characters, including the terminating null character, to
// the FileName output parameter.
//
// The client's fax user account SHOULD have write file access under the fax server
// queue directory.<191>
//
// Return Values: This method MUST return 0x00000000 (ERROR_SUCCESS) for success; otherwise,
// it MUST return one of the fax-specific errors that are defined in section 2.2.52
// or one of the other standard errors defined in [MS-ERREF] section 2.2. There are
// no predefined specific error codes to be returned by this method.
//
// Exceptions Thrown: No exceptions are thrown except those that are thrown by the underlying
// RPC protocol, [MS-RPCE].
GetQueueFileName(context.Context, *GetQueueFileNameRequest, ...dcerpc.CallOption) (*GetQueueFileNameResponse, error)
// The FaxObs_EnumJobs (Opnum 7) method is called by the client to enumerate the fax
// jobs on the server.
//
// Return Values: This method MUST return 0x00000000 (ERROR_SUCCESS) for success; otherwise,
// it MUST return one of the following error codes, one of the fax-specific errors that
// are defined in section 2.2.52, or one of the other standard errors defined in [MS-ERREF]
// section 2.2.
//
// +------------------------------------+----------------------------------------------------------------------------------+
// | RETURN | |
// | VALUE/CODE | DESCRIPTION |
// | | |
// +------------------------------------+----------------------------------------------------------------------------------+
// +------------------------------------+----------------------------------------------------------------------------------+
// | ERROR_ACCESS_DENIED 0x00000005 | Access is denied. The client's fax user account does not have the FAX_ JOB_QUERY |
// | | access rights. |
// +------------------------------------+----------------------------------------------------------------------------------+
// | ERROR_NOT_ENOUGH_MEMORY 0x00000008 | The fax server cannot allocate memory for the data to be returned to the client. |
// +------------------------------------+----------------------------------------------------------------------------------+
// | ERROR_INVALID_PARAMETER 0x00000057 | The parameter is incorrect. This error code is returned when any of the |
// | | following conditions are met: § The Buffer parameter is set to a NULL pointer |
// | | value. § The BufferSize parameter is set to a NULL pointer value. <194> § The |
// | | JobsReturned parameter is set to a NULL pointer value. <195> |
// +------------------------------------+----------------------------------------------------------------------------------+
//
// Exceptions Thrown: No exceptions are thrown except those that are thrown by the underlying
// RPC protocol, [MS-RPCE].
EnumJobs(context.Context, *EnumJobsRequest, ...dcerpc.CallOption) (*EnumJobsResponse, error)
// The FaxObs_GetJob (Opnum 8) method is called by the client to retrieve information
// regarding a specific job. The job is specified by the JobId parameter. The value
// for JobId can be obtained by calling the FaxObs_EnumJobs (section 3.1.4.2.9) or FaxObs_SendDocument
// (section 3.1.4.2.7) method.
//
// Return Values: This method MUST return 0x00000000 (ERROR_SUCCESS) for success; otherwise,
// it MUST return one of the following error codes, one of the fax-specific errors that
// are defined in section 2.2.52, or one of the other standard errors defined in [MS-ERREF]
// section 2.2.
//
// +------------------------------------+----------------------------------------------------------------------------------+
// | RETURN | |
// | VALUE/CODE | DESCRIPTION |
// | | |
// +------------------------------------+----------------------------------------------------------------------------------+
// +------------------------------------+----------------------------------------------------------------------------------+
// | ERROR_ACCESS_DENIED 0x00000005 | Access is denied. The client's fax user account does not have the FAX_JOB_QUERY |
// | | access rights. |
// +------------------------------------+----------------------------------------------------------------------------------+
// | ERROR_NOT_ENOUGH_MEMORY 0x00000008 | The fax server cannot allocate memory for the data to be returned to the client. |
// +------------------------------------+----------------------------------------------------------------------------------+
GetJob(context.Context, *GetJobRequest, ...dcerpc.CallOption) (*GetJobResponse, error)
// The FaxObs_SetJob (Opnum 9) method is called by the client to pause, resume, or cancel
// a fax job. The value for the JobId parameter can be obtained by calling the FaxObs_EnumJobs
// (section 3.1.4.2.9) or FaxObs_SendDocument (section 3.1.4.2.7) method.
//
// On success, the server MUST pause, resume, or cancel the specified fax job and MUST
// set the job status (section 3.1.1) to reflect the new job state.
//
// Return Values: This method MUST return 0x00000000 (ERROR_SUCCESS) for success; otherwise,
// it MUST return one of the following error codes, one of the fax-specific errors that
// are defined in section 2.2.52, or one of the other standard errors defined in [MS-ERREF]
// section 2.2.
//
// +------------------------------------+----------------------------------------------------------------------------------+
// | RETURN | |
// | VALUE/CODE | DESCRIPTION |
// | | |
// +------------------------------------+----------------------------------------------------------------------------------+
// +------------------------------------+----------------------------------------------------------------------------------+
// | ERROR_ACCESS_DENIED 0x00000005 | Access is denied. This error code is returned under any of the following |
// | | conditions: § The client's fax user account does not have the FAX_ JOB_MANAGE |
// | | access rights. § The client's fax user account is not the owner of the fax job |
// | | identified by the JobId parameter. |
// +------------------------------------+----------------------------------------------------------------------------------+
// | ERROR_INVALID_PARAMETER 0x00000057 | The parameter is incorrect. This error code is returned under any of the |
// | | following conditions: § The fax job indicated by JobId cannot be found by the |
// | | fax server. § The specified Command parameter value is not JC_DELETE, JC_PAUSE, |
// | | or JC_RESUME. § The specified Command value is JC_DELETE, the specified JobId |
// | | represents the job for an outgoing broadcast message, and aborting outgoing |
// | | broadcast messages is not supported. For more information, see FaxObs_Abort. § |
// | | The JobId is set to a NULL pointer value. |
// +------------------------------------+----------------------------------------------------------------------------------+
//
// Exceptions Thrown: No exceptions are thrown except those that are thrown by the underlying
// RPC protocol, [MS-RPCE].
SetJob(context.Context, *SetJobRequest, ...dcerpc.CallOption) (*SetJobResponse, error)
// The FaxObs_GetPageData (Opnum 10) method is called by the client to retrieve the
// data from the first page of an outgoing fax job. The information that is returned
// in the buffer is an in-memory copy of the first page of the TIFF file for the job.
// The value for the JobId parameter can be obtained by calling the FaxObs_EnumJobs
// (section 3.1.4.2.9) method.
//
// Return Values: This method MUST return 0x00000000 (ERROR_SUCCESS) for success; otherwise,
// it MUST return one of the following error codes, one of the fax-specific errors that
// are defined in section 2.2.52, or one of the other standard errors defined in [MS-ERREF]
// section 2.2.
//
// +------------------------------------+----------------------------------------------------------------------------------+
// | RETURN | |
// | VALUE/CODE | DESCRIPTION |
// | | |
// +------------------------------------+----------------------------------------------------------------------------------+
// +------------------------------------+----------------------------------------------------------------------------------+
// | ERROR_ACCESS_DENIED 0x00000005 | Access is denied. The client's fax user account does not have the FAX_JOB_QUERY |
// | | access rights. |
// +------------------------------------+----------------------------------------------------------------------------------+
// | ERROR_NOT_ENOUGH_MEMORY 0x00000008 | The fax server cannot allocate memory for the data to be returned to the client. |
// +------------------------------------+----------------------------------------------------------------------------------+
// | ERROR_INVALID_DATA 0x0000000D | The job identified by the JobId parameter is not an outgoing fax job. |
// +------------------------------------+----------------------------------------------------------------------------------+
// | ERROR_INVALID_PARAMETER 0x00000057 | The parameter is incorrect. This error code is returned under any of the |
// | | following conditions: § One or more of the following parameters are set to NULL |
// | | pointer values: Buffer, BufferSize, ImageWidth, and ImageHeight.<197> § The fax |
// | | server cannot find the fax job indicated by the JobId parameter. |
// +------------------------------------+----------------------------------------------------------------------------------+
//
// Exceptions Thrown: No exceptions are thrown except those that are thrown by the underlying
// RPC protocol, [MS-RPCE].
GetPageData(context.Context, *GetPageDataRequest, ...dcerpc.CallOption) (*GetPageDataResponse, error)
// The FaxObs_GetDeviceStatus (Opnum 11) method is called by the client to retrieve
// information about a specified fax device (port).
//
// Return Values: This method MUST return 0x00000000 (ERROR_SUCCESS) for success; otherwise,
// it MUST return one of the following error codes, one of the fax-specific errors that
// are defined in section 2.2.52, or one of the other standard errors defined in [MS-ERREF]
// section 2.2.
//
// +------------------------------------+----------------------------------------------------------------------------------+
// | RETURN | |
// | VALUE/CODE | DESCRIPTION |
// | | |
// +------------------------------------+----------------------------------------------------------------------------------+
// +------------------------------------+----------------------------------------------------------------------------------+
// | ERROR_ACCESS_DENIED 0x00000005 | Access is denied. The client's fax user account does not have the FAX_PORT_QUERY |
// | | access rights. |
// +------------------------------------+----------------------------------------------------------------------------------+
// | ERROR_NOT_ENOUGH_MEMORY 0x00000008 | The fax server cannot allocate memory for the data to be returned to the client. |
// +------------------------------------+----------------------------------------------------------------------------------+
// | ERROR_INVALID_DATA 0x0000000D | This error SHOULD be returned if the FaxPortHandle parameter is not a valid |
// | | handle obtained using FaxObs_OpenPort.<198> |
// +------------------------------------+----------------------------------------------------------------------------------+
//
// Exceptions Thrown: No exceptions are thrown except those that are thrown by the underlying
// RPC protocol, [MS-RPCE].
GetDeviceStatus(context.Context, *GetDeviceStatusRequest, ...dcerpc.CallOption) (*GetDeviceStatusResponse, error)
// The FaxObs_Abort (Opnum 12) method is called by the client to abort the specified
// fax job on the server. The value for the JobId parameter can be obtained by calling
// the FaxObs_EnumJobs (section 3.1.4.2.9) or FaxObs_SendDocument (section 3.1.4.2.7)
// method.
//
// Return Values: This method MUST return 0x00000000 (ERROR_SUCCESS) for success; otherwise,
// it MUST return one of the following error codes, one of the fax-specific errors that
// are defined in section 2.2.52, or one of the other standard errors defined in [MS-ERREF]
// section 2.2.
//
// +------------------------------------+----------------------------------------------------------------------------------+
// | RETURN | |
// | VALUE/CODE | DESCRIPTION |
// | | |
// +------------------------------------+----------------------------------------------------------------------------------+
// +------------------------------------+----------------------------------------------------------------------------------+
// | ERROR_ACCESS_DENIED 0x00000005 | Access is denied. This error code is returned under any of the following |
// | | conditions: § The client's fax user account does not have the FAX_ JOB_MANAGE |
// | | access rights. § The client's fax user account is not the owner of the fax job |
// | | identified by the JobId parameter. |
// +------------------------------------+----------------------------------------------------------------------------------+
// | ERROR_INVALID_PARAMETER 0x00000057 | The parameter is incorrect. This error code is returned when any of the |
// | | following conditions are met: § The fax job identified by the specified JobId |
// | | cannot be found by the fax server. § The specified job has already been canceled |
// | | or is in the process of being canceled. § The specified JobId represents the job |
// | | for an outgoing broadcast message; aborting outgoing broadcast messages is not |
// | | supported. |
// +------------------------------------+----------------------------------------------------------------------------------+
//
// Exceptions Thrown: No exceptions are thrown except those that are thrown by the underlying
// RPC protocol, [MS-RPCE].
Abort(context.Context, *AbortRequest, ...dcerpc.CallOption) (*AbortResponse, error)
// The FaxObs_EnumPorts (Opnum 13) method is called by the client to enumerate the fax
// ports (devices) on the server and retrieve information describing these ports (devices).
//
// Return Values: This method MUST return 0x00000000 (ERROR_SUCCESS) for success; otherwise,
// it MUST return one of the following error codes, one of the fax-specific errors that
// are defined in section 2.2.52, or one of the other standard errors defined in [MS-ERREF]
// section 2.2.
//
// +------------------------------------+----------------------------------------------------------------------------------+
// | RETURN | |
// | VALUE/CODE | DESCRIPTION |
// | | |
// +------------------------------------+----------------------------------------------------------------------------------+
// +------------------------------------+----------------------------------------------------------------------------------+
// | ERROR_ACCESS_DENIED 0x00000005 | Access is denied. The client's fax user account does not have the FAX_ |
// | | PORT_QUERY access rights. |
// +------------------------------------+----------------------------------------------------------------------------------+
// | ERROR_NOT_ENOUGH_MEMORY 0x00000008 | The fax server cannot allocate sufficient memory to hold the array of |
// | | _FAX_PORT_INFO structures to be returned to the client. |
// +------------------------------------+----------------------------------------------------------------------------------+
// | ERROR_INVALID_PARAMETER 0x00000057 | The PortsReturned parameter is set to a NULL pointer value.<199> |
// +------------------------------------+----------------------------------------------------------------------------------+
//
// Exceptions Thrown: No exceptions are thrown except those that are thrown by the underlying
// RPC protocol, [MS-RPCE].
EnumPorts(context.Context, *EnumPortsRequest, ...dcerpc.CallOption) (*EnumPortsResponse, error)
// The FaxObs_GetPort (Opnum 14) method is called by the client to retrieve status information
// from the server about the specified fax port (device).
//
// Return Values: This method MUST return 0x00000000 (ERROR_SUCCESS) for success; otherwise,
// it MUST return one of the following error codes, one of the fax-specific errors that
// are defined in section 2.2.52, or one of the other standard errors defined in [MS-ERREF]
// section 2.2.
//
// +------------------------------------+----------------------------------------------------------------------------------+
// | RETURN | |
// | VALUE/CODE | DESCRIPTION |
// | | |
// +------------------------------------+----------------------------------------------------------------------------------+
// +------------------------------------+----------------------------------------------------------------------------------+
// | ERROR_ACCESS_DENIED 0x00000005 | Access is denied. The client's fax user account does not have the FAX_PORT_QUERY |
// | | access rights. |
// +------------------------------------+----------------------------------------------------------------------------------+
// | ERROR_NOT_ENOUGH_MEMORY 0x00000008 | The fax server cannot allocate sufficient memory to hold the _FAX_PORT_INFO to |
// | | be returned to the client. |
// +------------------------------------+----------------------------------------------------------------------------------+
// | ERROR_INVALID_DATA 0x0000000D | This error SHOULD be returned if the FaxPortHandle argument is not a valid |
// | | handle obtained using FaxObs_OpenPort.<200> |
// +------------------------------------+----------------------------------------------------------------------------------+
//
// Exceptions Thrown: No exceptions are thrown except those that are thrown by the underlying
// RPC protocol, [MS-RPCE].
GetPort(context.Context, *GetPortRequest, ...dcerpc.CallOption) (*GetPortResponse, error)
// The client calls the FaxObs_SetPort (Opnum 15) method to change the configuration
// of a fax port (device). The function sets extension configuration properties that
// are stored at the device level, such as enabling or disabling sending and receiving,
// and the automatic or manual answering of calls.
//
// The client MUST set the FaxPortHandle parameter to a valid fax port handle value
// returned by the FaxObs_OpenPort (section 3.1.4.2.5) method. The server MUST validate
// that the client's fax user account has the access to change the port configuration.
// On success, the server MUST modify the properties of the port as specified by the
// client.
//
// Return Values: This method MUST return 0x00000000 (ERROR_SUCCESS) for success; otherwise,
// it MUST return one of the following error codes, one of the fax-specific errors that
// are defined in section 2.2.52, or one of the other standard errors defined in [MS-ERREF]
// section 2.2.
//
// +------------------------------------+----------------------------------------------------------------------------------+
// | RETURN | |
// | VALUE/CODE | DESCRIPTION |
// | | |
// +------------------------------------+----------------------------------------------------------------------------------+
// +------------------------------------+----------------------------------------------------------------------------------+
// | ERROR_ACCESS_DENIED 0x00000005 | Access is denied. The client's fax user account does not have the FAX_PORT_SET |
// | | access rights. |
// +------------------------------------+----------------------------------------------------------------------------------+
// | ERROR_INVALID_DATA 0x0000000D | The handle specified by the FaxPortHandle argument is not a valid fax port |
// | | handle obtained by a call to FaxObs_OpenPort.<201> |
// +------------------------------------+----------------------------------------------------------------------------------+
// | ERROR_INVALID_PARAMETER 0x00000057 | The size of FAX_PORT_INFO, specified in the SizeOfStruct field, is incorrect. |
// +------------------------------------+----------------------------------------------------------------------------------+
// | ERROR_DEVICE_IN_USE 0x00000964 | The specified fax port is currently sending or receiving a fax transmission. |
// +------------------------------------+----------------------------------------------------------------------------------+
//
// Exceptions Thrown: No exceptions are thrown except those that are thrown by the underlying
// RPC protocol, [MS-RPCE].
SetPort(context.Context, *SetPortRequest, ...dcerpc.CallOption) (*SetPortResponse, error)
// The FaxObs_EnumRoutingMethods (Opnum 16) method is called by the client to enumerate
// all of the routing methods that are registered with the server for a specified port
// (device). The function returns detailed information about each enumerated routing
// method.
//
// The client MUST set the FaxPortHandle parameter to a valid fax port handle value
// returned by the FaxObs_OpenPort (section 3.1.4.2.5) method.
//
// Return Values: This method MUST return 0x00000000 (ERROR_SUCCESS) for success; otherwise,
// it MUST return one of the following error codes, one of the fax-specific errors that
// are defined in section 2.2.52 or one of the other standard errors defined in [MS-ERREF]
// section 2.2.
//
// +------------------------------------+----------------------------------------------------------------------------------+
// | RETURN | |
// | VALUE/CODE | DESCRIPTION |
// | | |
// +------------------------------------+----------------------------------------------------------------------------------+
// +------------------------------------+----------------------------------------------------------------------------------+
// | ERROR_INVALID_FUNCTION 0x00000001 | There are no routing methods configured on the fax server for the fax port |
// | | specified through the FaxPortHandle parameter. |
// +------------------------------------+----------------------------------------------------------------------------------+
// | ERROR_ACCESS_DENIED 0x00000005 | Access is denied. The client's fax user account does not have the FAX_PORT_QUERY |
// | | access rights. |
// +------------------------------------+----------------------------------------------------------------------------------+
// | ERROR_NOT_ENOUGH_MEMORY 0x00000008 | The fax server cannot allocate sufficient memory to hold the array of |
// | | FAX_ROUTING_METHOD structures to be returned to the client. |
// +------------------------------------+----------------------------------------------------------------------------------+
// | ERROR_INVALID_DATA 0x0000000D | This error SHOULD be returned if the FaxPortHandle argument is not a valid |
// | | handle obtained using FaxObs_OpenPort.<202> |
// +------------------------------------+----------------------------------------------------------------------------------+
// | ERROR_INVALID_PARAMETER 0x00000057 | The parameter is incorrect. This error code is returned if any of the |
// | | following parameters is set to a NULL pointer value: RoutingInfoBuffer, |
// | | RoutingInfoBufferSize, PortsReturned.<203> |
// +------------------------------------+----------------------------------------------------------------------------------+
//
// Exceptions Thrown: No exceptions are thrown except those that are thrown by the underlying
// RPC protocol, [MS-RPCE].
EnumRoutingMethods(context.Context, *EnumRoutingMethodsRequest, ...dcerpc.CallOption) (*EnumRoutingMethodsResponse, error)
// The FaxObs_EnableRoutingMethod (Opnum 17) method is called by the client to enable
// or disable a routing method for a fax port (device).
//
// The client MUST set the FaxPortHandle parameter to a valid fax port handle value
// returned by the FaxObs_OpenPort (section 3.1.4.2.5) method. In response, the server
// MUST validate that the client's fax user account has access to enable or disable
// routing methods. The client MUST set the RoutingGUID parameter to point to a valid
// routing method.
//
// On success, the server MUST enable or disable a fax routing method for the specified
// fax port (device).
//
// Return Values: This method MUST return 0x00000000 (ERROR_SUCCESS) for success; otherwise,
// it MUST return one of the following error codes, one of the fax-specific errors that
// are defined in section 2.2.52, or one of the other standard errors defined in [MS-ERREF]
// section 2.2.
//
// +--------------------------------+----------------------------------------------------------------------------------+
// | RETURN | |
// | VALUE/CODE | DESCRIPTION |
// | | |
// +--------------------------------+----------------------------------------------------------------------------------+
// +--------------------------------+----------------------------------------------------------------------------------+
// | ERROR_ACCESS_DENIED 0x00000005 | Access is denied. The client's fax user account does not have the FAX_PORT_SET |
// | | access rights. |
// +--------------------------------+----------------------------------------------------------------------------------+
// | ERROR_INVALID_DATA 0x0000000D | The data is invalid. This error code is returned when any of the following |
// | | conditions are met: § The FaxPortHandle argument is not a valid handle obtained |
// | | using FaxObs_OpenPort.<204> § The GUID specified by the RoutingGuid parameter is |
// | | not a routing method GUID. |
// +--------------------------------+----------------------------------------------------------------------------------+
//
// Exceptions Thrown: No exceptions are thrown except those that are thrown by the underlying
// RPC protocol, [MS-RPCE].
EnableRoutingMethod(context.Context, *EnableRoutingMethodRequest, ...dcerpc.CallOption) (*EnableRoutingMethodResponse, error)
// The FaxObs_GetRoutingInfo (Opnum 18) method is called by the client to retrieve information
// about a routing method.
//
// The client MUST set the FaxPortHandle parameter to a valid fax port handle value
// returned by the FaxObs_OpenPort (section 3.1.4.2.5) method.
//
// Return Values: This method MUST return 0x00000000 (ERROR_SUCCESS) for success; otherwise,
// it MUST return one of the following error codes, one of the fax-specific errors that
// are defined in section 2.2.52, or one of the other standard errors defined in [MS-ERREF]
// section 2.2.
//
// +------------------------------------+----------------------------------------------------------------------------------+
// | RETURN | |
// | VALUE/CODE | DESCRIPTION |
// | | |
// +------------------------------------+----------------------------------------------------------------------------------+
// +------------------------------------+----------------------------------------------------------------------------------+
// | ERROR_ACCESS_DENIED 0x00000005 | Access is denied. The client's fax user account does not have the FAX_PORT_QUERY |
// | | access rights. |
// +------------------------------------+----------------------------------------------------------------------------------+
// | ERROR_NOT_ENOUGH_MEMORY 0x00000008 | The fax server cannot allocate sufficient memory for the data to be returned to |
// | | the client. |
// +------------------------------------+----------------------------------------------------------------------------------+
// | ERROR_INVALID_DATA 0x0000000D | The data is invalid. This error code is returned when any of the following |
// | | conditions are met: § The FaxPortHandle argument is not a valid handle obtained |
// | | using FaxObs_OpenPort.<205> § The GUID specified by the RoutingGuid parameter is |
// | | not a routing method GUID. |
// +------------------------------------+----------------------------------------------------------------------------------+
// | ERROR_INVALID_PARAMETER 0x00000057 | The parameter is incorrect. One or more of the following parameters are set to |
// | | NULL pointer values: RoutingGuid, RoutingInfoBuffer, RoutingInfoBufferSize.<206> |
// +------------------------------------+----------------------------------------------------------------------------------+
//
// Exceptions Thrown: No exceptions are thrown except those that are thrown by the underlying
// RPC protocol, [MS-RPCE].
GetRoutingInfo(context.Context, *GetRoutingInfoRequest, ...dcerpc.CallOption) (*GetRoutingInfoResponse, error)
// The FaxObs_SetRoutingInfo (Opnum 19) method is called by the client to set routing
// information for a fax routing method.
//
// The client MUST set the FaxPortHandle parameter to a valid fax port handle value
// returned by the FaxObs_OpenPort (section 3.1.4.2.5) method.
//
// Return Values: This method MUST return 0x00000000 (ERROR_SUCCESS) for success; otherwise,
// it MUST return one of the following error codes, one of the fax-specific errors that
// are defined in section 2.2.52, or one of the other standard errors defined in [MS-ERREF]
// section 2.2.
//
// +------------------------------------+----------------------------------------------------------------------------------+
// | RETURN | |
// | VALUE/CODE | DESCRIPTION |
// | | |
// +------------------------------------+----------------------------------------------------------------------------------+
// +------------------------------------+----------------------------------------------------------------------------------+
// | ERROR_ACCESS_DENIED 0x00000005 | Access is denied. The client's fax user account does not have the FAX_PORT_SET |
// | | access rights. |
// +------------------------------------+----------------------------------------------------------------------------------+
// | ERROR_INVALID_DATA 0x0000000D | The data is invalid. This error code is returned when any of the following |
// | | conditions are met: § The FaxPortHandle argument is not a valid handle obtained |
// | | using FaxObs_OpenPort.<207> § The GUID specified by the RoutingGuid parameter is |
// | | not a routing method GUID. § The routing extension specified by the RoutingGuid |
// | | or the routing extension implementing the routing method specified by the |
// | | RoutingGuid denies the request to set the data requested by the fax client. |
// +------------------------------------+----------------------------------------------------------------------------------+
// | ERROR_INVALID_PARAMETER 0x00000057 | The parameter is incorrect. One or more of the following parameters are set to |
// | | NULL pointer values: RoutingGuid, RoutingInfoBuffer, RoutingInfoBufferSize. |
// +------------------------------------+----------------------------------------------------------------------------------+
//
// Exceptions Thrown: No exceptions are thrown except those that are thrown by the underlying
// RPC protocol, [MS-RPCE].
SetRoutingInfo(context.Context, *SetRoutingInfoRequest, ...dcerpc.CallOption) (*SetRoutingInfoResponse, error)
// The FaxObs_EnumGlobalRoutingInfo (Opnum 20) method is called by the client to enumerate
// global routing information.
//
// Return Values: This method MUST return 0x00000000 (ERROR_SUCCESS) for success; otherwise,
// it MUST return one of the following error codes, one of the fax-specific errors that
// are defined in section 2.2.52, or one of the other standard errors defined in [MS-ERREF]
// section 2.2.
//
// +------------------------------------+----------------------------------------------------------------------------------+
// | RETURN | |
// | VALUE/CODE | DESCRIPTION |
// | | |
// +------------------------------------+----------------------------------------------------------------------------------+
// +------------------------------------+----------------------------------------------------------------------------------+
// | ERROR_INVALID_FUNCTION 0x00000001 | There are no routing methods currently configured on the fax server. |
// +------------------------------------+----------------------------------------------------------------------------------+
// | ERROR_ACCESS_DENIED 0x00000005 | Access is denied. The client's fax user account does not have the |
// | | FAX_CONFIG_QUERY access rights. |
// +------------------------------------+----------------------------------------------------------------------------------+
// | ERROR_NOT_ENOUGH_MEMORY 0x00000008 | The fax server cannot allocate sufficient memory to hold the array of |
// | | _FAX_GLOBAL_ROUTING_INFOW structures to be returned to the client. |
// +------------------------------------+----------------------------------------------------------------------------------+
// | ERROR_INVALID_PARAMETER 0x00000057 | The parameter is incorrect. One or more of the following parameters are |
// | | set to NULL pointer values: RoutingInfoBuffer, RoutingInfoBufferSize, and |
// | | MethodsReturned. <208> |
// +------------------------------------+----------------------------------------------------------------------------------+
//
// Exceptions Thrown: No exceptions are thrown except those that are thrown by the underlying
// RPC protocol, [MS-RPCE].
EnumGlobalRoutingInfo(context.Context, *EnumGlobalRoutingInfoRequest, ...dcerpc.CallOption) (*EnumGlobalRoutingInfoResponse, error)
// The fax client calls the FaxObs_SetGlobalRoutingInfo (Opnum 21) method to set global
// routing properties, such as the routing method priority.
//
// Return Values: This method MUST return 0x00000000 (ERROR_SUCCESS) for success; otherwise,
// it MUST return one of the following error codes, one of the fax-specific errors that
// are defined in section 2.2.52, or one of the other standard errors defined in [MS-ERREF]
// section 2.2.
//
// +------------------------------------+----------------------------------------------------------------------------------+
// | RETURN | |
// | VALUE/CODE | DESCRIPTION |
// | | |
// +------------------------------------+----------------------------------------------------------------------------------+
// +------------------------------------+----------------------------------------------------------------------------------+
// | ERROR_ACCESS_DENIED 0x00000005 | Access is denied. The client's fax user account does not have the FAX_CONFIG_SET |
// | | access rights. |
// +------------------------------------+----------------------------------------------------------------------------------+
// | ERROR_INVALID_DATA 0x0000000D | The fax server cannot find the routing method specified by the Guid structure |
// | | field of the RoutingInfo parameter. |
// +------------------------------------+----------------------------------------------------------------------------------+
// | ERROR_INVALID_PARAMETER 0x00000057 | The parameter is incorrect. This error code is returned if any of the following |
// | | conditions are met: § The RoutingInfo is set to a NULL pointer value. § The |
// | | SizeOfStruct structure field of the RoutingInfo is not set to the correct size |
// | | in bytes for the FAX_GLOBAL_ROUTING_INFO. |
// +------------------------------------+----------------------------------------------------------------------------------+
//
// Exceptions Thrown: No exceptions are thrown except those that are thrown by the underlying
// RPC protocol, [MS-RPCE].
SetGlobalRoutingInfo(context.Context, *SetGlobalRoutingInfoRequest, ...dcerpc.CallOption) (*SetGlobalRoutingInfoResponse, error)
// The FaxObs_GetConfiguration (Opnum 22) method is called by the client to retrieve
// information about the configuration of the fax server.
//
// Return Values: This method MUST return 0x00000000 (ERROR_SUCCESS) for success; otherwise,
// it MUST return one of the following error codes, one of the fax-specific errors that
// are defined in section 2.2.52, or one of the other standard errors defined in [MS-ERREF]
// section 2.2.
//
// +------------------------------------+----------------------------------------------------------------------------------+
// | RETURN | |
// | VALUE/CODE | DESCRIPTION |
// | | |
// +------------------------------------+----------------------------------------------------------------------------------+
// +------------------------------------+----------------------------------------------------------------------------------+
// | ERROR_ACCESS_DENIED 0x00000005 | Access is denied. The client's fax user account does not have the |
// | | FAX_CONFIG_QUERY access rights. |
// +------------------------------------+----------------------------------------------------------------------------------+
// | ERROR_NOT_ENOUGH_MEMORY 0x00000008 | The fax server cannot allocate sufficient memory to hold the _FAX_CONFIGURATIONW |
// | | to be returned to the client. |
// +------------------------------------+----------------------------------------------------------------------------------+
// | ERROR_INVALID_PARAMETER 0x00000057 | The parameter is incorrect. This error code is returned if the Buffer or |
// | | BufferSize parameters are set to NULL pointer values. |
// +------------------------------------+----------------------------------------------------------------------------------+
//
// Exceptions Thrown: No exceptions are thrown except those that are thrown by the underlying
// RPC protocol, [MS-RPCE].
GetConfiguration(context.Context, *GetConfigurationRequest, ...dcerpc.CallOption) (*GetConfigurationResponse, error)
// The client calls the FaxObs_SetConfiguration (Opnum 23) method to change the fax
// server configuration.
//
// Return Values: This method MUST return 0x00000000 (ERROR_SUCCESS) for success; otherwise,
// it MUST return one of the following error codes, one of the fax-specific errors that
// are defined in section 2.2.52, or one of the other standard errors defined in [MS-ERREF]
// section 2.2.
//
// +------------------------------------+----------------------------------------------------------------------------------+
// | RETURN | |
// | VALUE/CODE | DESCRIPTION |
// | | |
// +------------------------------------+----------------------------------------------------------------------------------+
// +------------------------------------+----------------------------------------------------------------------------------+
// | ERROR_ACCESS_DENIED 0x00000005 | Access is denied. The client's fax user account does not have the FAX_CONFIG_SET |
// | | access rights. |
// +------------------------------------+----------------------------------------------------------------------------------+
// | ERROR_INVALID_DATA 0x0000000D | The fax server failed to add (apply) the new MAPI profile specified by the |
// | | Reserved member of the FaxConfig structure. |
// +------------------------------------+----------------------------------------------------------------------------------+
// | ERROR_INVALID_PARAMETER 0x00000057 | The parameter is incorrect. This error code is returned under any of the |
// | | following conditions: § The pointer specified with the FaxConfig argument is |
// | | NULL. § The dwSizeOfStruct member of the FAX_CONFIGURATIONW specified by the |
// | | FaxConfig parameter is set to an incorrect value. § The ArchiveOutgoingFaxes |
// | | member of the FaxConfig structure is set to TRUE and the ArchiveDirectory member |
// | | of this same structure is set to a NULL pointer value. |
// +------------------------------------+----------------------------------------------------------------------------------+
//
// Exceptions Thrown: No exceptions are thrown except those that are thrown by the underlying
// RPC protocol, [MS-RPCE].
SetConfiguration(context.Context, *SetConfigurationRequest, ...dcerpc.CallOption) (*SetConfigurationResponse, error)
// The FaxObs_GetLoggingCategories (Opnum 24) method is called by the client to retrieve
// the current logging categories from the server. A logging category determines the
// errors or other events that the fax server records in the application event log.
//
// Return Values: This method MUST return 0x00000000 (ERROR_SUCCESS) for success; otherwise,
// it MUST return one of the following error codes, one of the fax-specific errors that
// are defined in section 2.2.52, or one of the other standard errors defined in [MS-ERREF]
// section 2.2.
//
// +------------------------------------+----------------------------------------------------------------------------------+
// | RETURN | |
// | VALUE/CODE | DESCRIPTION |
// | | |
// +------------------------------------+----------------------------------------------------------------------------------+
// +------------------------------------+----------------------------------------------------------------------------------+
// | ERROR_ACCESS_DENIED 0x00000005 | Access is denied. The client's fax user account does not have the |
// | | FAX_CONFIG_QUERY access rights. |
// +------------------------------------+----------------------------------------------------------------------------------+
// | ERROR_NOT_ENOUGH_MEMORY 0x00000008 | The fax server cannot allocate sufficient memory to hold the array of |
// | | FAX_LOG_CATEGORY structures to be returned to the client. |
// +------------------------------------+----------------------------------------------------------------------------------+
// | ERROR_INVALID_PARAMETER 0x00000057 | The parameter is incorrect. This error is returned if one of more of the |
// | | following parameters are set to NULL pointer values: Buffer, BufferSize, |
// | | NumberCategories. <210> |
// +------------------------------------+----------------------------------------------------------------------------------+
//
// Exceptions Thrown: No exceptions are thrown except those that are thrown by the underlying
// RPC protocol, [MS-RPCE].
GetLoggingCategories(context.Context, *GetLoggingCategoriesRequest, ...dcerpc.CallOption) (*GetLoggingCategoriesResponse, error)
// The FaxObs_SetLoggingCategories (Opnum 25) method is called by the client to set
// the current logging categories on the server. A logging category determines the errors
// or other events that the fax server records in the application event log.
//
// On success, the server MUST modify its current logging categories.
//
// Return Values: This method MUST return 0x00000000 (ERROR_SUCCESS) for success; otherwise,
// it MUST return one of the following error codes, one of the fax-specific errors that
// are defined in section 2.2.52, or one of the other standard errors defined in [MS-ERREF]
// section 2.2.
//
// +------------------------------------+----------------------------------------------------------------------------------+
// | RETURN | |
// | VALUE/CODE | DESCRIPTION |
// | | |
// +------------------------------------+----------------------------------------------------------------------------------+
// +------------------------------------+----------------------------------------------------------------------------------+
// | ERROR_ACCESS_DENIED 0x00000005 | Access is denied. The client's fax user account does not have the FAX_CONFIG_SET |
// | | access rights. |
// +------------------------------------+----------------------------------------------------------------------------------+
// | ERROR_INVALID_PARAMETER 0x00000057 | The parameter is incorrect. This error code is returned under any of the |
// | | following conditions: § The value specified for the Buffer parameter is NULL. § |
// | | The value specified for the BufferSize parameter is 0. |
// +------------------------------------+----------------------------------------------------------------------------------+
//
// Exceptions Thrown: No exceptions are thrown except those that are thrown by the underlying
// RPC protocol, [MS-RPCE].
SetLoggingCategories(context.Context, *SetLoggingCategoriesRequest, ...dcerpc.CallOption) (*SetLoggingCategoriesResponse, error)
// The FaxObs_GetTapiLocations (Opnum 26) method is called by the client to retrieve
// the current and other available TAPI locations configured for the server. The TAPI
// locations can be set by the client with the FaxObs_SetTapiLocations (section 3.1.4.2.29)
// method.
//
// A TAPI location is described by a FAX_TAPI_LOCATIONS (section 2.2.88) data structure,
// which includes information such as a friendly name, country code, and area code for
// the respective location. For more information about TAPI see [MSDN-TAPI2.2].
//
// On success, the server MUST allocate memory for and return the data describing its
// current and other available TAPI locations.
//
// The client SHOULD free the buffer.
//
// Return Values: This method MUST return 0x00000000 (ERROR_SUCCESS) for success; otherwise,
// it MUST return one of the following error codes, one of the fax-specific errors that
// are defined in section 2.2.52, or one of the other standard errors defined in [MS-ERREF]
// section 2.2.
//
// +------------------------------------+----------------------------------------------------------------------------------+
// | RETURN | |
// | VALUE/CODE | DESCRIPTION |
// | | |
// +------------------------------------+----------------------------------------------------------------------------------+
// +------------------------------------+----------------------------------------------------------------------------------+
// | ERROR_ACCESS_DENIED 0x00000005 | Access is denied. The client's fax user account does not have the |
// | | FAX_CONFIG_QUERY access rights. |
// +------------------------------------+----------------------------------------------------------------------------------+
// | ERROR_NOT_ENOUGH_MEMORY 0x00000008 | The fax server cannot allocate sufficient memory to hold the data to be returned |
// | | to the client. |
// +------------------------------------+----------------------------------------------------------------------------------+
// | ERROR_INVALID_PARAMETER 0x00000057 | The parameter is incorrect. This error is returned if any of the following |
// | | parameters are set to a NULL pointer value: Buffer or BufferSize.<211> |
// +------------------------------------+----------------------------------------------------------------------------------+
//
// Exceptions Thrown: No exceptions are thrown except those that are thrown by the underlying
// RPC protocol, [MS-RPCE].
GetTAPILocations(context.Context, *GetTAPILocationsRequest, ...dcerpc.CallOption) (*GetTAPILocationsResponse, error)
// The FaxObs_SetTapiLocations (Opnum 27) method is called by the client to set the
// current and other available TAPI locations for the server. The TAPI locations can
// be retrieved by the client with the FaxObs_GetTapiLocations (section 3.1.4.2.28)
// method.
//
// A TAPI location is described by a FAX_TAPI_LOCATIONS (section 2.2.88) data structure,
// which includes information such as a friendly name, country code, and area code for
// the respective location. For more information about TAPI, see [MSDN-TAPI2.2].
//
// On success, the server MUST apply the new locations configuration that was requested
// by the client.
//
// Return Values: This method MUST return 0x00000000 (ERROR_SUCCESS) for success; otherwise,
// it MUST return one of the following error codes, one of the fax-specific errors that
// are defined in section 2.2.52, or one of the other standard errors defined in [MS-ERREF]
// section 2.2.
//
// +------------------------------------+----------------------------------------------------------------------------------+
// | RETURN | |
// | VALUE/CODE | DESCRIPTION |
// | | |
// +------------------------------------+----------------------------------------------------------------------------------+
// +------------------------------------+----------------------------------------------------------------------------------+
// | ERROR_ACCESS_DENIED 0x00000005 | Access is denied. The client's fax user account does not have the FAX_CONFIG_SET |
// | | access rights. |
// +------------------------------------+----------------------------------------------------------------------------------+
// | ERROR_INVALID_PARAMETER 0x00000057 | The parameter is incorrect. This error is returned if the Buffer parameter is |
// | | set to a NULL pointer value. |
// +------------------------------------+----------------------------------------------------------------------------------+
//
// Exceptions Thrown: No exceptions are thrown except those that are thrown by the underlying
// RPC protocol, [MS-RPCE].
SetTAPILocations(context.Context, *SetTAPILocationsRequest, ...dcerpc.CallOption) (*SetTAPILocationsResponse, error)
// The FaxObs_GetMapiProfiles (Opnum 28) method is called by the client to retrieve
// the names of the current MAPI profiles set for the fax server. For more information
// about MAPI profiles, see [MSDN-MAPIPRF].
//
// On success, the server MUST allocate memory for, and return the list of, the current
// MAPI profile names. They MUST be formatted as a sequence of null-terminated character
// strings, with the sequence terminated by a single empty, null-terminated character
// string.
//
// The client SHOULD free the buffer.
//
// Return Values: This method MUST return 0x00000000 (ERROR_SUCCESS) for success; otherwise,
// it MUST return one of the following error codes, one of the fax-specific errors that
// are defined in section 2.2.52, or one of the other standard errors defined in [MS-ERREF]
// section 2.2.
//
// +------------------------------------+----------------------------------------------------------------------------------+
// | RETURN | |
// | VALUE/CODE | DESCRIPTION |
// | | |
// +------------------------------------+----------------------------------------------------------------------------------+
// +------------------------------------+----------------------------------------------------------------------------------+
// | ERROR_ACCESS_DENIED 0x00000005 | Access is denied. The client's fax user account does not have the |
// | | FAX_CONFIG_QUERY access rights. |
// +------------------------------------+----------------------------------------------------------------------------------+
// | ERROR_INVALID_PARAMETER 0x00000057 | The parameter is incorrect. This error is returned if the MapiProfiles or the |
// | | BufferSize parameters are set to NULL pointer values. <212> |
// +------------------------------------+----------------------------------------------------------------------------------+
//
// Exceptions Thrown: No exceptions are thrown except those that are thrown by the underlying
// RPC protocol, [MS-RPCE].
GetMAPIProfiles(context.Context, *GetMAPIProfilesRequest, ...dcerpc.CallOption) (*GetMAPIProfilesResponse, error)
// The FaxObs_StartClientServer (Opnum 29) method is called by the client to register
// itself to receive notifications of fax events from the server.
//
// On success, the server MUST start notifying the client about the occurring fax events.
//
// If the server receives a FaxObs_StartClientServer request for a client machine name
// and client name that are already registered to receive fax event notifications with
// a previously executed FaxObs_StartClientServer call, the fax server MUST consider
// the new request a success and keep the existing fax client registration.
//
// To notify the client about a fax event, the server MUST first open a connection with
// the client by calling the FAX_OpenConnection (section 3.2.4.5) method. Then the fax
// server MUST notify the client by calling the FAX_ClientEventQueue (section 3.2.4.2)
// method. Finally, the server SHOULD close the connection with the client by calling
// the FAX_CloseConnection (section 3.2.4.4) method. <213>
//
// Return Values: This method MUST return 0x00000000 (ERROR_SUCCESS) for success; otherwise,
// it MUST return the following error code, one of the fax-specific errors that are
// defined in section 2.2.52, or one of the other standard errors defined in [MS-ERREF]
// section 2.2.
//
// +------------------------------------+--------------------------------------------------------------------------------+
// | RETURN | |
// | VALUE/CODE | DESCRIPTION |
// | | |
// +------------------------------------+--------------------------------------------------------------------------------+
// +------------------------------------+--------------------------------------------------------------------------------+
// | ERROR_NOT_ENOUGH_MEMORY 0x00000008 | The fax server cannot allocate memory necessary for the fax client connection. |
// +------------------------------------+--------------------------------------------------------------------------------+
//
// Exceptions Thrown: No exceptions are thrown except those that are thrown by the underlying
// RPC protocol, [MS-RPCE].
StartClientServer(context.Context, *StartClientServerRequest, ...dcerpc.CallOption) (*StartClientServerResponse, error)
// The client calls FaxObs_GetSecurityDescriptor (Opnum 31) method to retrieve the fax
// security descriptor of the server. The client can set the fax security descriptor
// of the server with the FaxObs_SetSecurityDescriptor (section 3.1.4.2.33) method.
//
// On success, the server MUST allocate memory for the return data buffer and return
// a FAX_SECURITY_DESCRIPTOR (section 2.2.90) structure.
//
// The client SHOULD free the buffer.
//
// Return Values: This method MUST return 0x00000000 (ERROR_SUCCESS) for success; otherwise,
// it MUST return one of the following error codes, one of the fax-specific errors that
// are defined in section 2.2.52, or one of the other standard errors defined in [MS-ERREF]
// section 2.2.
//
// +------------------------------------+----------------------------------------------------------------------------------+
// | RETURN | |
// | VALUE/CODE | DESCRIPTION |
// | | |
// +------------------------------------+----------------------------------------------------------------------------------+
// +------------------------------------+----------------------------------------------------------------------------------+
// | ERROR_ACCESS_DENIED 0x00000005 | Access is denied. The client's fax user account does not have the |
// | | FAX_CONFIG_QUERY access rights. |
// +------------------------------------+----------------------------------------------------------------------------------+
// | ERROR_NOT_ENOUGH_MEMORY 0x00000008 | The server cannot allocate sufficient memory to hold the FAX_SECURITY_DESCRIPTOR |
// | | to be returned to the client. |
// +------------------------------------+----------------------------------------------------------------------------------+
// | ERROR_INVALID_CATEGORY 0x00000075 | The server SHOULD return this error code if the value of the Id parameter is |
// | | greater than 0.<214> |
// +------------------------------------+----------------------------------------------------------------------------------+
//
// Exceptions Thrown: No exceptions are thrown except those that are thrown by the underlying
// RPC protocol, [MS-RPCE].
GetSecurityDescriptor(context.Context, *GetSecurityDescriptorRequest, ...dcerpc.CallOption) (*GetSecurityDescriptorResponse, error)
// The client calls FaxObs_SetSecurityDescriptor (Opnum 32) method to set the fax security
// descriptor of the server. The client can retrieve the security descriptor of the
// server with the FaxObs_GetSecurityDescriptor (section 3.1.4.2.32) method.
//
// On success, the server MUST apply the security descriptor described in the submitted
// FAX_SECURITY_DESCRIPTOR (section 2.2.90) structure.
//
// Return Values: This method MUST return 0x00000000 (ERROR_SUCCESS) for success; otherwise,
// it MUST return one of the following error codes, one of the fax-specific errors that
// are defined in section 2.2.52, or one of the other standard errors defined in [MS-ERREF]
// section 2.2.
//
// +------------------------------------+----------------------------------------------------------------------------------+
// | RETURN | |
// | VALUE/CODE | DESCRIPTION |
// | | |
// +------------------------------------+----------------------------------------------------------------------------------+
// +------------------------------------+----------------------------------------------------------------------------------+
// | ERROR_ACCESS_DENIED 0x00000005 | Access is denied. The client's fax user account does not have the FAX_CONFIG_SET |
// | | access rights. |
// +------------------------------------+----------------------------------------------------------------------------------+
// | ERROR_INVALID_DATA 0x0000000D | The security descriptor described by the FAX_SECURITY_DESCRIPTOR pointed at by |
// | | the FaxSecurityDecriptor parameter is invalid. |
// +------------------------------------+----------------------------------------------------------------------------------+
// | ERROR_INVALID_PARAMETER 0x00000057 | The parameter is incorrect. This error code is returned under any of the |
// | | following conditions: § The value of the BufferSize parameter is less than the |
// | | size of the Fixed_Portion block of the FAX_SECURITY_DESCRIPTOR. § An offset |
// | | into the Fixed_Portion block of the FAX_SECURITY_DESCRIPTOR pointed at by the |
// | | FaxSecurityDecriptor points to outside of the buffer. |
// +------------------------------------+----------------------------------------------------------------------------------+
// | ERROR_INVALID_CATEGORY 0x00000075 | The fax server SHOULD return this error if the Id member of the |
// | | FAX_SECURITY_DESCRIPTOR specified by the FaxSecurityDescriptor argument is set |
// | | to a value greater than 0.<215> |
// +------------------------------------+----------------------------------------------------------------------------------+
//
// Exceptions Thrown: No exceptions are thrown except those that are thrown by the underlying
// RPC protocol, [MS-RPCE].
SetSecurityDescriptor(context.Context, *SetSecurityDescriptorRequest, ...dcerpc.CallOption) (*SetSecurityDescriptorResponse, error)
// The client calls the FaxObs_GetSecurityDescriptorCount (Opnum 33) method to retrieve
// the total number of fax security descriptors from the server.
//
// On success, the server MUST return the total number of security descriptors. This
// number MUST be 1.
//
// Return Values: This method MUST return 0x00000000 (ERROR_SUCCESS) for success; otherwise,
// it MUST return one of the fax-specific errors that are defined in section 2.2.52
// or one of the other standard errors defined in [MS-ERREF] section 2.2. There are
// no predefined error codes to be returned by this method.
//
// Exceptions Thrown: No exceptions are thrown except those that are thrown by the underlying
// RPC protocol, [MS-RPCE].
GetSecurityDescriptorCount(context.Context, *GetSecurityDescriptorCountRequest, ...dcerpc.CallOption) (*GetSecurityDescriptorCountResponse, error)
// The FaxObs_AccessCheck (Opnum 34) method is called by the client to check whether
// the currently logged-on client user account has access permissions to execute specific
// fax operations on the fax server.
//
// Return Values: This method MUST return 0x00000000 (ERROR_SUCCESS) for success; otherwise,
// it MUST return one of the following error codes, one of the fax-specific errors that
// are defined in section 2.2.52, or one of the other standard errors defined in [MS-ERREF]
// section 2.2.
//
// +------------------------------------+----------------------------------------------------------------------------------+
// | RETURN | |
// | VALUE/CODE | DESCRIPTION |
// | | |
// +------------------------------------+----------------------------------------------------------------------------------+
// +------------------------------------+----------------------------------------------------------------------------------+
// | ERROR_INVALID_PARAMETER 0x00000057 | The parameter is incorrect. This error code is returned if any of the following |
// | | conditions are met: § The hBinding parameter is set to a NULL value. <216> § The |
// | | fAccess parameter is set to a NULL pointer value. <217> |
// +------------------------------------+----------------------------------------------------------------------------------+
//
// Exceptions Thrown: No exceptions are thrown except those that are thrown by the underlying
// RPC protocol, [MS-RPCE].
AccessCheck(context.Context, *AccessCheckRequest, ...dcerpc.CallOption) (*AccessCheckResponse, error)
// AlterContext alters the client context.
AlterContext(context.Context, ...dcerpc.Option) error
}
faxobs interface.
func NewFaxobsClient ¶
type FaxobsServer ¶
type FaxobsServer interface {
// The FaxObs_ConnectionRefCount (Opnum 0) method is called by the client to connect
// to or disconnect from the server.
//
// Return Values: This method MUST return 0x00000000 (ERROR_SUCCESS) for success; otherwise,
// it MUST return one of the fax-specific errors that are defined in section 2.2.52
// or one of the other standard errors defined in [MS-ERREF] section 2.2. There are
// no predefined specific error codes to be returned by this method.
//
// Exceptions Thrown: No exceptions are thrown except those that are thrown by the underlying
// RPC protocol, [MS-RPCE].
ConnectionReferenceCount(context.Context, *ConnectionReferenceCountRequest) (*ConnectionReferenceCountResponse, error)
// The client calls the FaxObs_GetVersion (Opnum 1) method to obtain the version number
// of the server.
//
// Return Values: This method MUST return 0x00000000 (ERROR_SUCCESS) for success; otherwise,
// it MUST return the following error code, one of the fax-specific errors that are
// defined in section 2.2.52, or one of the other standard errors defined in [MS-ERREF]
// section 2.2.
//
// +------------------------------------+------------------------------------------------------------+
// | RETURN | |
// | VALUE/CODE | DESCRIPTION |
// | | |
// +------------------------------------+------------------------------------------------------------+
// +------------------------------------+------------------------------------------------------------+
// | ERROR_INVALID_PARAMETER 0x00000057 | The Version parameter is set to a NULL pointer value.<184> |
// +------------------------------------+------------------------------------------------------------+
//
// Exceptions Thrown: No exceptions are thrown except those that are thrown by the underlying
// RPC protocol, [MS-RPCE].
GetVersion(context.Context, *GetVersionRequest) (*GetVersionResponse, error)
// The client calls the FaxObs_GetInstallType (Opnum 2) method to obtain information
// about the server installation.
//
// Return Values: This method MUST return 0x00000000 (ERROR_SUCCESS) for success; otherwise,
// it MUST return the following error code, one of the fax-specific errors that are
// defined in section 2.2.52, or one of the other standard errors defined in [MS-ERREF]
// section 2.2.
//
// +-----------------------------------+------------------------------------------------------------------------------+
// | RETURN | |
// | VALUE/CODE | DESCRIPTION |
// | | |
// +-----------------------------------+------------------------------------------------------------------------------+
// +-----------------------------------+------------------------------------------------------------------------------+
// | ERROR_INVALID_FUNCTION 0x00000001 | The fax server is unable to retrieve the requested installation information. |
// +-----------------------------------+------------------------------------------------------------------------------+
//
// Exceptions Thrown: No exceptions are thrown except those that are thrown by the underlying
// RPC protocol, [MS-RPCE].
GetInstallType(context.Context, *GetInstallTypeRequest) (*GetInstallTypeResponse, error)
// The client calls the FaxObs_OpenPort (Opnum 3) method to open a fax port and obtain
// a fax port handle.
//
// Return Values: This method MUST return 0x00000000 (ERROR_SUCCESS) for success; otherwise,
// it MUST return one of the following error codes, one of the fax-specific errors that
// are defined in section 2.2.52, or one of the other standard errors defined in [MS-ERREF]
// section 2.2.
//
// +------------------------------------+----------------------------------------------------------------------------------+
// | RETURN | |
// | VALUE/CODE | DESCRIPTION |
// | | |
// +------------------------------------+----------------------------------------------------------------------------------+
// +------------------------------------+----------------------------------------------------------------------------------+
// | ERROR_ACCESS_DENIED 0x00000005 | Access is denied. The caller does not have the FAX_PORT_QUERY access rights |
// | | required for this operation. |
// +------------------------------------+----------------------------------------------------------------------------------+
// | ERROR_INVALID_HANDLE 0x00000006 | The call was made with the Flags parameter containing the PORT_OPEN_MODIFY flag, |
// | | and the port is already opened to be modified by another call. |
// +------------------------------------+----------------------------------------------------------------------------------+
// | ERROR_BAD_UNIT 0x00000014 | The system cannot find the port for the receiving device by using the line |
// | | identifier specified by the DeviceId parameter. |
// +------------------------------------+----------------------------------------------------------------------------------+
// | ERROR_INVALID_PARAMETER 0x00000057 | The FaxPortHandle parameter is set to a NULL pointer value.<188> |
// +------------------------------------+----------------------------------------------------------------------------------+
//
// Exceptions Thrown: No exceptions are thrown except those that are thrown by the underlying
// RPC protocol, [MS-RPCE].
OpenPort(context.Context, *OpenPortRequest) (*OpenPortResponse, error)
// The client calls the FaxObs_ClosePort (Opnum 4) method to close a fax port and release
// the fax port handle obtained with a FaxObs_OpenPort (section 3.1.4.2.5) call.
//
// On success, the server MUST close the specified port and release the handle.
//
// Return Values: This method MUST return 0x00000000 (ERROR_SUCCESS) for success; otherwise,
// it MUST return the following error code, one of the fax-specific errors that are
// defined in section 2.2.52, or one of the other standard errors defined in [MS-ERREF]
// section 2.2.
//
// +--------------------------------+----------------------------------------------------------------------------------+
// | RETURN | |
// | VALUE/CODE | DESCRIPTION |
// | | |
// +--------------------------------+----------------------------------------------------------------------------------+
// +--------------------------------+----------------------------------------------------------------------------------+
// | ERROR_ACCESS_DENIED 0x00000005 | Access is denied. The client's fax user account does not have the FAX_PORT_QUERY |
// | | access rights required for this operation. |
// +--------------------------------+----------------------------------------------------------------------------------+
//
// Exceptions Thrown: No exceptions are thrown except those that are thrown by the underlying
// RPC protocol, [MS-RPCE].
ClosePort(context.Context, *ClosePortRequest) (*ClosePortResponse, error)
// The client calls the FaxObs_SendDocument (Opnum 5) method to send a document.
//
// Return Values: This method MUST return 0x00000000 (ERROR_SUCCESS) for success; otherwise,
// it MUST return one of the following error codes, one of the fax-specific errors that
// are defined in section 2.2.52, or one of the other standard errors defined in [MS-ERREF]
// section 2.2.
//
// +------------------------------------+----------------------------------------------------------------------------------+
// | RETURN | |
// | VALUE/CODE | DESCRIPTION |
// | | |
// +------------------------------------+----------------------------------------------------------------------------------+
// +------------------------------------+----------------------------------------------------------------------------------+
// | ERROR_ACCESS_DENIED 0x00000005 | Access is denied. The client's fax user account does not have the FAX_JOB_SUBMIT |
// | | access rights required for this operation. |
// +------------------------------------+----------------------------------------------------------------------------------+
// | ERROR_INVALID_PARAMETER 0x00000057 | The parameter is incorrect. This error code is returned under any of the |
// | | following conditions: § The JobParams parameter is set to a NULL pointer |
// | | value. § The FileName parameter is set to a NULL pointer value. § The FaxJobId |
// | | parameter is set to a NULL pointer value.<190> § The length of the character |
// | | string specified by the FileName parameter (excluding the length of the |
// | | terminating null character) plus the length of the fax queue directory path name |
// | | (excluding the length of the terminating null character) exceeds 253 characters. |
// | | This error can occur if the fax client is not using a file path name obtained |
// | | from FaxObs_GetQueueFileName. § Either of the following conditions are true: § |
// | | The first value of the Reserved field of the structure referenced by JobParams |
// | | is set to 0xFFFFFFFE (32-bit) or 0x00000000FFFFFFFE (64-bit). The second value |
// | | of this same Reserved field is set to 0x00000002 (32-bit) or 0x0000000000000002 |
// | | (64-bit). The RecipientNumber field of the same structure is set to NULL. § The |
// | | first value of the Reserved field of the structure referenced by JobParams is |
// | | not set to 0xFFFFFFFE (32-bit) or 0x00000000FFFFFFFE (64-bit). The CallHandle |
// | | field of the same structure is not set to 0x00000000. The RecipientNumber field |
// | | of the JobParams structure is NULL. |
// +------------------------------------+----------------------------------------------------------------------------------+
//
// Exceptions Thrown: No exceptions are thrown except those that are thrown by the underlying
// RPC protocol, [MS-RPCE].
SendDocument(context.Context, *SendDocumentRequest) (*SendDocumentResponse, error)
// The client calls FaxObs_GetQueueFileName (Opnum 6) to obtain from the server the
// name of a new file located in the fax server queue directory. The client can copy
// to this file the fax data to be transmitted and submit the file name to FaxObs_SendDocument
// (section 3.1.4.2.7).
//
// The client SHOULD set the FileNameSize parameter to a value of 255 characters. If
// the client sets FileNameSize to a value exceeding 255 characters, the server SHOULD
// NOT write more than 255 characters, including the terminating null character, to
// the FileName output parameter.
//
// The client's fax user account SHOULD have write file access under the fax server
// queue directory.<191>
//
// Return Values: This method MUST return 0x00000000 (ERROR_SUCCESS) for success; otherwise,
// it MUST return one of the fax-specific errors that are defined in section 2.2.52
// or one of the other standard errors defined in [MS-ERREF] section 2.2. There are
// no predefined specific error codes to be returned by this method.
//
// Exceptions Thrown: No exceptions are thrown except those that are thrown by the underlying
// RPC protocol, [MS-RPCE].
GetQueueFileName(context.Context, *GetQueueFileNameRequest) (*GetQueueFileNameResponse, error)
// The FaxObs_EnumJobs (Opnum 7) method is called by the client to enumerate the fax
// jobs on the server.
//
// Return Values: This method MUST return 0x00000000 (ERROR_SUCCESS) for success; otherwise,
// it MUST return one of the following error codes, one of the fax-specific errors that
// are defined in section 2.2.52, or one of the other standard errors defined in [MS-ERREF]
// section 2.2.
//
// +------------------------------------+----------------------------------------------------------------------------------+
// | RETURN | |
// | VALUE/CODE | DESCRIPTION |
// | | |
// +------------------------------------+----------------------------------------------------------------------------------+
// +------------------------------------+----------------------------------------------------------------------------------+
// | ERROR_ACCESS_DENIED 0x00000005 | Access is denied. The client's fax user account does not have the FAX_ JOB_QUERY |
// | | access rights. |
// +------------------------------------+----------------------------------------------------------------------------------+
// | ERROR_NOT_ENOUGH_MEMORY 0x00000008 | The fax server cannot allocate memory for the data to be returned to the client. |
// +------------------------------------+----------------------------------------------------------------------------------+
// | ERROR_INVALID_PARAMETER 0x00000057 | The parameter is incorrect. This error code is returned when any of the |
// | | following conditions are met: § The Buffer parameter is set to a NULL pointer |
// | | value. § The BufferSize parameter is set to a NULL pointer value. <194> § The |
// | | JobsReturned parameter is set to a NULL pointer value. <195> |
// +------------------------------------+----------------------------------------------------------------------------------+
//
// Exceptions Thrown: No exceptions are thrown except those that are thrown by the underlying
// RPC protocol, [MS-RPCE].
EnumJobs(context.Context, *EnumJobsRequest) (*EnumJobsResponse, error)
// The FaxObs_GetJob (Opnum 8) method is called by the client to retrieve information
// regarding a specific job. The job is specified by the JobId parameter. The value
// for JobId can be obtained by calling the FaxObs_EnumJobs (section 3.1.4.2.9) or FaxObs_SendDocument
// (section 3.1.4.2.7) method.
//
// Return Values: This method MUST return 0x00000000 (ERROR_SUCCESS) for success; otherwise,
// it MUST return one of the following error codes, one of the fax-specific errors that
// are defined in section 2.2.52, or one of the other standard errors defined in [MS-ERREF]
// section 2.2.
//
// +------------------------------------+----------------------------------------------------------------------------------+
// | RETURN | |
// | VALUE/CODE | DESCRIPTION |
// | | |
// +------------------------------------+----------------------------------------------------------------------------------+
// +------------------------------------+----------------------------------------------------------------------------------+
// | ERROR_ACCESS_DENIED 0x00000005 | Access is denied. The client's fax user account does not have the FAX_JOB_QUERY |
// | | access rights. |
// +------------------------------------+----------------------------------------------------------------------------------+
// | ERROR_NOT_ENOUGH_MEMORY 0x00000008 | The fax server cannot allocate memory for the data to be returned to the client. |
// +------------------------------------+----------------------------------------------------------------------------------+
GetJob(context.Context, *GetJobRequest) (*GetJobResponse, error)
// The FaxObs_SetJob (Opnum 9) method is called by the client to pause, resume, or cancel
// a fax job. The value for the JobId parameter can be obtained by calling the FaxObs_EnumJobs
// (section 3.1.4.2.9) or FaxObs_SendDocument (section 3.1.4.2.7) method.
//
// On success, the server MUST pause, resume, or cancel the specified fax job and MUST
// set the job status (section 3.1.1) to reflect the new job state.
//
// Return Values: This method MUST return 0x00000000 (ERROR_SUCCESS) for success; otherwise,
// it MUST return one of the following error codes, one of the fax-specific errors that
// are defined in section 2.2.52, or one of the other standard errors defined in [MS-ERREF]
// section 2.2.
//
// +------------------------------------+----------------------------------------------------------------------------------+
// | RETURN | |
// | VALUE/CODE | DESCRIPTION |
// | | |
// +------------------------------------+----------------------------------------------------------------------------------+
// +------------------------------------+----------------------------------------------------------------------------------+
// | ERROR_ACCESS_DENIED 0x00000005 | Access is denied. This error code is returned under any of the following |
// | | conditions: § The client's fax user account does not have the FAX_ JOB_MANAGE |
// | | access rights. § The client's fax user account is not the owner of the fax job |
// | | identified by the JobId parameter. |
// +------------------------------------+----------------------------------------------------------------------------------+
// | ERROR_INVALID_PARAMETER 0x00000057 | The parameter is incorrect. This error code is returned under any of the |
// | | following conditions: § The fax job indicated by JobId cannot be found by the |
// | | fax server. § The specified Command parameter value is not JC_DELETE, JC_PAUSE, |
// | | or JC_RESUME. § The specified Command value is JC_DELETE, the specified JobId |
// | | represents the job for an outgoing broadcast message, and aborting outgoing |
// | | broadcast messages is not supported. For more information, see FaxObs_Abort. § |
// | | The JobId is set to a NULL pointer value. |
// +------------------------------------+----------------------------------------------------------------------------------+
//
// Exceptions Thrown: No exceptions are thrown except those that are thrown by the underlying
// RPC protocol, [MS-RPCE].
SetJob(context.Context, *SetJobRequest) (*SetJobResponse, error)
// The FaxObs_GetPageData (Opnum 10) method is called by the client to retrieve the
// data from the first page of an outgoing fax job. The information that is returned
// in the buffer is an in-memory copy of the first page of the TIFF file for the job.
// The value for the JobId parameter can be obtained by calling the FaxObs_EnumJobs
// (section 3.1.4.2.9) method.
//
// Return Values: This method MUST return 0x00000000 (ERROR_SUCCESS) for success; otherwise,
// it MUST return one of the following error codes, one of the fax-specific errors that
// are defined in section 2.2.52, or one of the other standard errors defined in [MS-ERREF]
// section 2.2.
//
// +------------------------------------+----------------------------------------------------------------------------------+
// | RETURN | |
// | VALUE/CODE | DESCRIPTION |
// | | |
// +------------------------------------+----------------------------------------------------------------------------------+
// +------------------------------------+----------------------------------------------------------------------------------+
// | ERROR_ACCESS_DENIED 0x00000005 | Access is denied. The client's fax user account does not have the FAX_JOB_QUERY |
// | | access rights. |
// +------------------------------------+----------------------------------------------------------------------------------+
// | ERROR_NOT_ENOUGH_MEMORY 0x00000008 | The fax server cannot allocate memory for the data to be returned to the client. |
// +------------------------------------+----------------------------------------------------------------------------------+
// | ERROR_INVALID_DATA 0x0000000D | The job identified by the JobId parameter is not an outgoing fax job. |
// +------------------------------------+----------------------------------------------------------------------------------+
// | ERROR_INVALID_PARAMETER 0x00000057 | The parameter is incorrect. This error code is returned under any of the |
// | | following conditions: § One or more of the following parameters are set to NULL |
// | | pointer values: Buffer, BufferSize, ImageWidth, and ImageHeight.<197> § The fax |
// | | server cannot find the fax job indicated by the JobId parameter. |
// +------------------------------------+----------------------------------------------------------------------------------+
//
// Exceptions Thrown: No exceptions are thrown except those that are thrown by the underlying
// RPC protocol, [MS-RPCE].
GetPageData(context.Context, *GetPageDataRequest) (*GetPageDataResponse, error)
// The FaxObs_GetDeviceStatus (Opnum 11) method is called by the client to retrieve
// information about a specified fax device (port).
//
// Return Values: This method MUST return 0x00000000 (ERROR_SUCCESS) for success; otherwise,
// it MUST return one of the following error codes, one of the fax-specific errors that
// are defined in section 2.2.52, or one of the other standard errors defined in [MS-ERREF]
// section 2.2.
//
// +------------------------------------+----------------------------------------------------------------------------------+
// | RETURN | |
// | VALUE/CODE | DESCRIPTION |
// | | |
// +------------------------------------+----------------------------------------------------------------------------------+
// +------------------------------------+----------------------------------------------------------------------------------+
// | ERROR_ACCESS_DENIED 0x00000005 | Access is denied. The client's fax user account does not have the FAX_PORT_QUERY |
// | | access rights. |
// +------------------------------------+----------------------------------------------------------------------------------+
// | ERROR_NOT_ENOUGH_MEMORY 0x00000008 | The fax server cannot allocate memory for the data to be returned to the client. |
// +------------------------------------+----------------------------------------------------------------------------------+
// | ERROR_INVALID_DATA 0x0000000D | This error SHOULD be returned if the FaxPortHandle parameter is not a valid |
// | | handle obtained using FaxObs_OpenPort.<198> |
// +------------------------------------+----------------------------------------------------------------------------------+
//
// Exceptions Thrown: No exceptions are thrown except those that are thrown by the underlying
// RPC protocol, [MS-RPCE].
GetDeviceStatus(context.Context, *GetDeviceStatusRequest) (*GetDeviceStatusResponse, error)
// The FaxObs_Abort (Opnum 12) method is called by the client to abort the specified
// fax job on the server. The value for the JobId parameter can be obtained by calling
// the FaxObs_EnumJobs (section 3.1.4.2.9) or FaxObs_SendDocument (section 3.1.4.2.7)
// method.
//
// Return Values: This method MUST return 0x00000000 (ERROR_SUCCESS) for success; otherwise,
// it MUST return one of the following error codes, one of the fax-specific errors that
// are defined in section 2.2.52, or one of the other standard errors defined in [MS-ERREF]
// section 2.2.
//
// +------------------------------------+----------------------------------------------------------------------------------+
// | RETURN | |
// | VALUE/CODE | DESCRIPTION |
// | | |
// +------------------------------------+----------------------------------------------------------------------------------+
// +------------------------------------+----------------------------------------------------------------------------------+
// | ERROR_ACCESS_DENIED 0x00000005 | Access is denied. This error code is returned under any of the following |
// | | conditions: § The client's fax user account does not have the FAX_ JOB_MANAGE |
// | | access rights. § The client's fax user account is not the owner of the fax job |
// | | identified by the JobId parameter. |
// +------------------------------------+----------------------------------------------------------------------------------+
// | ERROR_INVALID_PARAMETER 0x00000057 | The parameter is incorrect. This error code is returned when any of the |
// | | following conditions are met: § The fax job identified by the specified JobId |
// | | cannot be found by the fax server. § The specified job has already been canceled |
// | | or is in the process of being canceled. § The specified JobId represents the job |
// | | for an outgoing broadcast message; aborting outgoing broadcast messages is not |
// | | supported. |
// +------------------------------------+----------------------------------------------------------------------------------+
//
// Exceptions Thrown: No exceptions are thrown except those that are thrown by the underlying
// RPC protocol, [MS-RPCE].
Abort(context.Context, *AbortRequest) (*AbortResponse, error)
// The FaxObs_EnumPorts (Opnum 13) method is called by the client to enumerate the fax
// ports (devices) on the server and retrieve information describing these ports (devices).
//
// Return Values: This method MUST return 0x00000000 (ERROR_SUCCESS) for success; otherwise,
// it MUST return one of the following error codes, one of the fax-specific errors that
// are defined in section 2.2.52, or one of the other standard errors defined in [MS-ERREF]
// section 2.2.
//
// +------------------------------------+----------------------------------------------------------------------------------+
// | RETURN | |
// | VALUE/CODE | DESCRIPTION |
// | | |
// +------------------------------------+----------------------------------------------------------------------------------+
// +------------------------------------+----------------------------------------------------------------------------------+
// | ERROR_ACCESS_DENIED 0x00000005 | Access is denied. The client's fax user account does not have the FAX_ |
// | | PORT_QUERY access rights. |
// +------------------------------------+----------------------------------------------------------------------------------+
// | ERROR_NOT_ENOUGH_MEMORY 0x00000008 | The fax server cannot allocate sufficient memory to hold the array of |
// | | _FAX_PORT_INFO structures to be returned to the client. |
// +------------------------------------+----------------------------------------------------------------------------------+
// | ERROR_INVALID_PARAMETER 0x00000057 | The PortsReturned parameter is set to a NULL pointer value.<199> |
// +------------------------------------+----------------------------------------------------------------------------------+
//
// Exceptions Thrown: No exceptions are thrown except those that are thrown by the underlying
// RPC protocol, [MS-RPCE].
EnumPorts(context.Context, *EnumPortsRequest) (*EnumPortsResponse, error)
// The FaxObs_GetPort (Opnum 14) method is called by the client to retrieve status information
// from the server about the specified fax port (device).
//
// Return Values: This method MUST return 0x00000000 (ERROR_SUCCESS) for success; otherwise,
// it MUST return one of the following error codes, one of the fax-specific errors that
// are defined in section 2.2.52, or one of the other standard errors defined in [MS-ERREF]
// section 2.2.
//
// +------------------------------------+----------------------------------------------------------------------------------+
// | RETURN | |
// | VALUE/CODE | DESCRIPTION |
// | | |
// +------------------------------------+----------------------------------------------------------------------------------+
// +------------------------------------+----------------------------------------------------------------------------------+
// | ERROR_ACCESS_DENIED 0x00000005 | Access is denied. The client's fax user account does not have the FAX_PORT_QUERY |
// | | access rights. |
// +------------------------------------+----------------------------------------------------------------------------------+
// | ERROR_NOT_ENOUGH_MEMORY 0x00000008 | The fax server cannot allocate sufficient memory to hold the _FAX_PORT_INFO to |
// | | be returned to the client. |
// +------------------------------------+----------------------------------------------------------------------------------+
// | ERROR_INVALID_DATA 0x0000000D | This error SHOULD be returned if the FaxPortHandle argument is not a valid |
// | | handle obtained using FaxObs_OpenPort.<200> |
// +------------------------------------+----------------------------------------------------------------------------------+
//
// Exceptions Thrown: No exceptions are thrown except those that are thrown by the underlying
// RPC protocol, [MS-RPCE].
GetPort(context.Context, *GetPortRequest) (*GetPortResponse, error)
// The client calls the FaxObs_SetPort (Opnum 15) method to change the configuration
// of a fax port (device). The function sets extension configuration properties that
// are stored at the device level, such as enabling or disabling sending and receiving,
// and the automatic or manual answering of calls.
//
// The client MUST set the FaxPortHandle parameter to a valid fax port handle value
// returned by the FaxObs_OpenPort (section 3.1.4.2.5) method. The server MUST validate
// that the client's fax user account has the access to change the port configuration.
// On success, the server MUST modify the properties of the port as specified by the
// client.
//
// Return Values: This method MUST return 0x00000000 (ERROR_SUCCESS) for success; otherwise,
// it MUST return one of the following error codes, one of the fax-specific errors that
// are defined in section 2.2.52, or one of the other standard errors defined in [MS-ERREF]
// section 2.2.
//
// +------------------------------------+----------------------------------------------------------------------------------+
// | RETURN | |
// | VALUE/CODE | DESCRIPTION |
// | | |
// +------------------------------------+----------------------------------------------------------------------------------+
// +------------------------------------+----------------------------------------------------------------------------------+
// | ERROR_ACCESS_DENIED 0x00000005 | Access is denied. The client's fax user account does not have the FAX_PORT_SET |
// | | access rights. |
// +------------------------------------+----------------------------------------------------------------------------------+
// | ERROR_INVALID_DATA 0x0000000D | The handle specified by the FaxPortHandle argument is not a valid fax port |
// | | handle obtained by a call to FaxObs_OpenPort.<201> |
// +------------------------------------+----------------------------------------------------------------------------------+
// | ERROR_INVALID_PARAMETER 0x00000057 | The size of FAX_PORT_INFO, specified in the SizeOfStruct field, is incorrect. |
// +------------------------------------+----------------------------------------------------------------------------------+
// | ERROR_DEVICE_IN_USE 0x00000964 | The specified fax port is currently sending or receiving a fax transmission. |
// +------------------------------------+----------------------------------------------------------------------------------+
//
// Exceptions Thrown: No exceptions are thrown except those that are thrown by the underlying
// RPC protocol, [MS-RPCE].
SetPort(context.Context, *SetPortRequest) (*SetPortResponse, error)
// The FaxObs_EnumRoutingMethods (Opnum 16) method is called by the client to enumerate
// all of the routing methods that are registered with the server for a specified port
// (device). The function returns detailed information about each enumerated routing
// method.
//
// The client MUST set the FaxPortHandle parameter to a valid fax port handle value
// returned by the FaxObs_OpenPort (section 3.1.4.2.5) method.
//
// Return Values: This method MUST return 0x00000000 (ERROR_SUCCESS) for success; otherwise,
// it MUST return one of the following error codes, one of the fax-specific errors that
// are defined in section 2.2.52 or one of the other standard errors defined in [MS-ERREF]
// section 2.2.
//
// +------------------------------------+----------------------------------------------------------------------------------+
// | RETURN | |
// | VALUE/CODE | DESCRIPTION |
// | | |
// +------------------------------------+----------------------------------------------------------------------------------+
// +------------------------------------+----------------------------------------------------------------------------------+
// | ERROR_INVALID_FUNCTION 0x00000001 | There are no routing methods configured on the fax server for the fax port |
// | | specified through the FaxPortHandle parameter. |
// +------------------------------------+----------------------------------------------------------------------------------+
// | ERROR_ACCESS_DENIED 0x00000005 | Access is denied. The client's fax user account does not have the FAX_PORT_QUERY |
// | | access rights. |
// +------------------------------------+----------------------------------------------------------------------------------+
// | ERROR_NOT_ENOUGH_MEMORY 0x00000008 | The fax server cannot allocate sufficient memory to hold the array of |
// | | FAX_ROUTING_METHOD structures to be returned to the client. |
// +------------------------------------+----------------------------------------------------------------------------------+
// | ERROR_INVALID_DATA 0x0000000D | This error SHOULD be returned if the FaxPortHandle argument is not a valid |
// | | handle obtained using FaxObs_OpenPort.<202> |
// +------------------------------------+----------------------------------------------------------------------------------+
// | ERROR_INVALID_PARAMETER 0x00000057 | The parameter is incorrect. This error code is returned if any of the |
// | | following parameters is set to a NULL pointer value: RoutingInfoBuffer, |
// | | RoutingInfoBufferSize, PortsReturned.<203> |
// +------------------------------------+----------------------------------------------------------------------------------+
//
// Exceptions Thrown: No exceptions are thrown except those that are thrown by the underlying
// RPC protocol, [MS-RPCE].
EnumRoutingMethods(context.Context, *EnumRoutingMethodsRequest) (*EnumRoutingMethodsResponse, error)
// The FaxObs_EnableRoutingMethod (Opnum 17) method is called by the client to enable
// or disable a routing method for a fax port (device).
//
// The client MUST set the FaxPortHandle parameter to a valid fax port handle value
// returned by the FaxObs_OpenPort (section 3.1.4.2.5) method. In response, the server
// MUST validate that the client's fax user account has access to enable or disable
// routing methods. The client MUST set the RoutingGUID parameter to point to a valid
// routing method.
//
// On success, the server MUST enable or disable a fax routing method for the specified
// fax port (device).
//
// Return Values: This method MUST return 0x00000000 (ERROR_SUCCESS) for success; otherwise,
// it MUST return one of the following error codes, one of the fax-specific errors that
// are defined in section 2.2.52, or one of the other standard errors defined in [MS-ERREF]
// section 2.2.
//
// +--------------------------------+----------------------------------------------------------------------------------+
// | RETURN | |
// | VALUE/CODE | DESCRIPTION |
// | | |
// +--------------------------------+----------------------------------------------------------------------------------+
// +--------------------------------+----------------------------------------------------------------------------------+
// | ERROR_ACCESS_DENIED 0x00000005 | Access is denied. The client's fax user account does not have the FAX_PORT_SET |
// | | access rights. |
// +--------------------------------+----------------------------------------------------------------------------------+
// | ERROR_INVALID_DATA 0x0000000D | The data is invalid. This error code is returned when any of the following |
// | | conditions are met: § The FaxPortHandle argument is not a valid handle obtained |
// | | using FaxObs_OpenPort.<204> § The GUID specified by the RoutingGuid parameter is |
// | | not a routing method GUID. |
// +--------------------------------+----------------------------------------------------------------------------------+
//
// Exceptions Thrown: No exceptions are thrown except those that are thrown by the underlying
// RPC protocol, [MS-RPCE].
EnableRoutingMethod(context.Context, *EnableRoutingMethodRequest) (*EnableRoutingMethodResponse, error)
// The FaxObs_GetRoutingInfo (Opnum 18) method is called by the client to retrieve information
// about a routing method.
//
// The client MUST set the FaxPortHandle parameter to a valid fax port handle value
// returned by the FaxObs_OpenPort (section 3.1.4.2.5) method.
//
// Return Values: This method MUST return 0x00000000 (ERROR_SUCCESS) for success; otherwise,
// it MUST return one of the following error codes, one of the fax-specific errors that
// are defined in section 2.2.52, or one of the other standard errors defined in [MS-ERREF]
// section 2.2.
//
// +------------------------------------+----------------------------------------------------------------------------------+
// | RETURN | |
// | VALUE/CODE | DESCRIPTION |
// | | |
// +------------------------------------+----------------------------------------------------------------------------------+
// +------------------------------------+----------------------------------------------------------------------------------+
// | ERROR_ACCESS_DENIED 0x00000005 | Access is denied. The client's fax user account does not have the FAX_PORT_QUERY |
// | | access rights. |
// +------------------------------------+----------------------------------------------------------------------------------+
// | ERROR_NOT_ENOUGH_MEMORY 0x00000008 | The fax server cannot allocate sufficient memory for the data to be returned to |
// | | the client. |
// +------------------------------------+----------------------------------------------------------------------------------+
// | ERROR_INVALID_DATA 0x0000000D | The data is invalid. This error code is returned when any of the following |
// | | conditions are met: § The FaxPortHandle argument is not a valid handle obtained |
// | | using FaxObs_OpenPort.<205> § The GUID specified by the RoutingGuid parameter is |
// | | not a routing method GUID. |
// +------------------------------------+----------------------------------------------------------------------------------+
// | ERROR_INVALID_PARAMETER 0x00000057 | The parameter is incorrect. One or more of the following parameters are set to |
// | | NULL pointer values: RoutingGuid, RoutingInfoBuffer, RoutingInfoBufferSize.<206> |
// +------------------------------------+----------------------------------------------------------------------------------+
//
// Exceptions Thrown: No exceptions are thrown except those that are thrown by the underlying
// RPC protocol, [MS-RPCE].
GetRoutingInfo(context.Context, *GetRoutingInfoRequest) (*GetRoutingInfoResponse, error)
// The FaxObs_SetRoutingInfo (Opnum 19) method is called by the client to set routing
// information for a fax routing method.
//
// The client MUST set the FaxPortHandle parameter to a valid fax port handle value
// returned by the FaxObs_OpenPort (section 3.1.4.2.5) method.
//
// Return Values: This method MUST return 0x00000000 (ERROR_SUCCESS) for success; otherwise,
// it MUST return one of the following error codes, one of the fax-specific errors that
// are defined in section 2.2.52, or one of the other standard errors defined in [MS-ERREF]
// section 2.2.
//
// +------------------------------------+----------------------------------------------------------------------------------+
// | RETURN | |
// | VALUE/CODE | DESCRIPTION |
// | | |
// +------------------------------------+----------------------------------------------------------------------------------+
// +------------------------------------+----------------------------------------------------------------------------------+
// | ERROR_ACCESS_DENIED 0x00000005 | Access is denied. The client's fax user account does not have the FAX_PORT_SET |
// | | access rights. |
// +------------------------------------+----------------------------------------------------------------------------------+
// | ERROR_INVALID_DATA 0x0000000D | The data is invalid. This error code is returned when any of the following |
// | | conditions are met: § The FaxPortHandle argument is not a valid handle obtained |
// | | using FaxObs_OpenPort.<207> § The GUID specified by the RoutingGuid parameter is |
// | | not a routing method GUID. § The routing extension specified by the RoutingGuid |
// | | or the routing extension implementing the routing method specified by the |
// | | RoutingGuid denies the request to set the data requested by the fax client. |
// +------------------------------------+----------------------------------------------------------------------------------+
// | ERROR_INVALID_PARAMETER 0x00000057 | The parameter is incorrect. One or more of the following parameters are set to |
// | | NULL pointer values: RoutingGuid, RoutingInfoBuffer, RoutingInfoBufferSize. |
// +------------------------------------+----------------------------------------------------------------------------------+
//
// Exceptions Thrown: No exceptions are thrown except those that are thrown by the underlying
// RPC protocol, [MS-RPCE].
SetRoutingInfo(context.Context, *SetRoutingInfoRequest) (*SetRoutingInfoResponse, error)
// The FaxObs_EnumGlobalRoutingInfo (Opnum 20) method is called by the client to enumerate
// global routing information.
//
// Return Values: This method MUST return 0x00000000 (ERROR_SUCCESS) for success; otherwise,
// it MUST return one of the following error codes, one of the fax-specific errors that
// are defined in section 2.2.52, or one of the other standard errors defined in [MS-ERREF]
// section 2.2.
//
// +------------------------------------+----------------------------------------------------------------------------------+
// | RETURN | |
// | VALUE/CODE | DESCRIPTION |
// | | |
// +------------------------------------+----------------------------------------------------------------------------------+
// +------------------------------------+----------------------------------------------------------------------------------+
// | ERROR_INVALID_FUNCTION 0x00000001 | There are no routing methods currently configured on the fax server. |
// +------------------------------------+----------------------------------------------------------------------------------+
// | ERROR_ACCESS_DENIED 0x00000005 | Access is denied. The client's fax user account does not have the |
// | | FAX_CONFIG_QUERY access rights. |
// +------------------------------------+----------------------------------------------------------------------------------+
// | ERROR_NOT_ENOUGH_MEMORY 0x00000008 | The fax server cannot allocate sufficient memory to hold the array of |
// | | _FAX_GLOBAL_ROUTING_INFOW structures to be returned to the client. |
// +------------------------------------+----------------------------------------------------------------------------------+
// | ERROR_INVALID_PARAMETER 0x00000057 | The parameter is incorrect. One or more of the following parameters are |
// | | set to NULL pointer values: RoutingInfoBuffer, RoutingInfoBufferSize, and |
// | | MethodsReturned. <208> |
// +------------------------------------+----------------------------------------------------------------------------------+
//
// Exceptions Thrown: No exceptions are thrown except those that are thrown by the underlying
// RPC protocol, [MS-RPCE].
EnumGlobalRoutingInfo(context.Context, *EnumGlobalRoutingInfoRequest) (*EnumGlobalRoutingInfoResponse, error)
// The fax client calls the FaxObs_SetGlobalRoutingInfo (Opnum 21) method to set global
// routing properties, such as the routing method priority.
//
// Return Values: This method MUST return 0x00000000 (ERROR_SUCCESS) for success; otherwise,
// it MUST return one of the following error codes, one of the fax-specific errors that
// are defined in section 2.2.52, or one of the other standard errors defined in [MS-ERREF]
// section 2.2.
//
// +------------------------------------+----------------------------------------------------------------------------------+
// | RETURN | |
// | VALUE/CODE | DESCRIPTION |
// | | |
// +------------------------------------+----------------------------------------------------------------------------------+
// +------------------------------------+----------------------------------------------------------------------------------+
// | ERROR_ACCESS_DENIED 0x00000005 | Access is denied. The client's fax user account does not have the FAX_CONFIG_SET |
// | | access rights. |
// +------------------------------------+----------------------------------------------------------------------------------+
// | ERROR_INVALID_DATA 0x0000000D | The fax server cannot find the routing method specified by the Guid structure |
// | | field of the RoutingInfo parameter. |
// +------------------------------------+----------------------------------------------------------------------------------+
// | ERROR_INVALID_PARAMETER 0x00000057 | The parameter is incorrect. This error code is returned if any of the following |
// | | conditions are met: § The RoutingInfo is set to a NULL pointer value. § The |
// | | SizeOfStruct structure field of the RoutingInfo is not set to the correct size |
// | | in bytes for the FAX_GLOBAL_ROUTING_INFO. |
// +------------------------------------+----------------------------------------------------------------------------------+
//
// Exceptions Thrown: No exceptions are thrown except those that are thrown by the underlying
// RPC protocol, [MS-RPCE].
SetGlobalRoutingInfo(context.Context, *SetGlobalRoutingInfoRequest) (*SetGlobalRoutingInfoResponse, error)
// The FaxObs_GetConfiguration (Opnum 22) method is called by the client to retrieve
// information about the configuration of the fax server.
//
// Return Values: This method MUST return 0x00000000 (ERROR_SUCCESS) for success; otherwise,
// it MUST return one of the following error codes, one of the fax-specific errors that
// are defined in section 2.2.52, or one of the other standard errors defined in [MS-ERREF]
// section 2.2.
//
// +------------------------------------+----------------------------------------------------------------------------------+
// | RETURN | |
// | VALUE/CODE | DESCRIPTION |
// | | |
// +------------------------------------+----------------------------------------------------------------------------------+
// +------------------------------------+----------------------------------------------------------------------------------+
// | ERROR_ACCESS_DENIED 0x00000005 | Access is denied. The client's fax user account does not have the |
// | | FAX_CONFIG_QUERY access rights. |
// +------------------------------------+----------------------------------------------------------------------------------+
// | ERROR_NOT_ENOUGH_MEMORY 0x00000008 | The fax server cannot allocate sufficient memory to hold the _FAX_CONFIGURATIONW |
// | | to be returned to the client. |
// +------------------------------------+----------------------------------------------------------------------------------+
// | ERROR_INVALID_PARAMETER 0x00000057 | The parameter is incorrect. This error code is returned if the Buffer or |
// | | BufferSize parameters are set to NULL pointer values. |
// +------------------------------------+----------------------------------------------------------------------------------+
//
// Exceptions Thrown: No exceptions are thrown except those that are thrown by the underlying
// RPC protocol, [MS-RPCE].
GetConfiguration(context.Context, *GetConfigurationRequest) (*GetConfigurationResponse, error)
// The client calls the FaxObs_SetConfiguration (Opnum 23) method to change the fax
// server configuration.
//
// Return Values: This method MUST return 0x00000000 (ERROR_SUCCESS) for success; otherwise,
// it MUST return one of the following error codes, one of the fax-specific errors that
// are defined in section 2.2.52, or one of the other standard errors defined in [MS-ERREF]
// section 2.2.
//
// +------------------------------------+----------------------------------------------------------------------------------+
// | RETURN | |
// | VALUE/CODE | DESCRIPTION |
// | | |
// +------------------------------------+----------------------------------------------------------------------------------+
// +------------------------------------+----------------------------------------------------------------------------------+
// | ERROR_ACCESS_DENIED 0x00000005 | Access is denied. The client's fax user account does not have the FAX_CONFIG_SET |
// | | access rights. |
// +------------------------------------+----------------------------------------------------------------------------------+
// | ERROR_INVALID_DATA 0x0000000D | The fax server failed to add (apply) the new MAPI profile specified by the |
// | | Reserved member of the FaxConfig structure. |
// +------------------------------------+----------------------------------------------------------------------------------+
// | ERROR_INVALID_PARAMETER 0x00000057 | The parameter is incorrect. This error code is returned under any of the |
// | | following conditions: § The pointer specified with the FaxConfig argument is |
// | | NULL. § The dwSizeOfStruct member of the FAX_CONFIGURATIONW specified by the |
// | | FaxConfig parameter is set to an incorrect value. § The ArchiveOutgoingFaxes |
// | | member of the FaxConfig structure is set to TRUE and the ArchiveDirectory member |
// | | of this same structure is set to a NULL pointer value. |
// +------------------------------------+----------------------------------------------------------------------------------+
//
// Exceptions Thrown: No exceptions are thrown except those that are thrown by the underlying
// RPC protocol, [MS-RPCE].
SetConfiguration(context.Context, *SetConfigurationRequest) (*SetConfigurationResponse, error)
// The FaxObs_GetLoggingCategories (Opnum 24) method is called by the client to retrieve
// the current logging categories from the server. A logging category determines the
// errors or other events that the fax server records in the application event log.
//
// Return Values: This method MUST return 0x00000000 (ERROR_SUCCESS) for success; otherwise,
// it MUST return one of the following error codes, one of the fax-specific errors that
// are defined in section 2.2.52, or one of the other standard errors defined in [MS-ERREF]
// section 2.2.
//
// +------------------------------------+----------------------------------------------------------------------------------+
// | RETURN | |
// | VALUE/CODE | DESCRIPTION |
// | | |
// +------------------------------------+----------------------------------------------------------------------------------+
// +------------------------------------+----------------------------------------------------------------------------------+
// | ERROR_ACCESS_DENIED 0x00000005 | Access is denied. The client's fax user account does not have the |
// | | FAX_CONFIG_QUERY access rights. |
// +------------------------------------+----------------------------------------------------------------------------------+
// | ERROR_NOT_ENOUGH_MEMORY 0x00000008 | The fax server cannot allocate sufficient memory to hold the array of |
// | | FAX_LOG_CATEGORY structures to be returned to the client. |
// +------------------------------------+----------------------------------------------------------------------------------+
// | ERROR_INVALID_PARAMETER 0x00000057 | The parameter is incorrect. This error is returned if one of more of the |
// | | following parameters are set to NULL pointer values: Buffer, BufferSize, |
// | | NumberCategories. <210> |
// +------------------------------------+----------------------------------------------------------------------------------+
//
// Exceptions Thrown: No exceptions are thrown except those that are thrown by the underlying
// RPC protocol, [MS-RPCE].
GetLoggingCategories(context.Context, *GetLoggingCategoriesRequest) (*GetLoggingCategoriesResponse, error)
// The FaxObs_SetLoggingCategories (Opnum 25) method is called by the client to set
// the current logging categories on the server. A logging category determines the errors
// or other events that the fax server records in the application event log.
//
// On success, the server MUST modify its current logging categories.
//
// Return Values: This method MUST return 0x00000000 (ERROR_SUCCESS) for success; otherwise,
// it MUST return one of the following error codes, one of the fax-specific errors that
// are defined in section 2.2.52, or one of the other standard errors defined in [MS-ERREF]
// section 2.2.
//
// +------------------------------------+----------------------------------------------------------------------------------+
// | RETURN | |
// | VALUE/CODE | DESCRIPTION |
// | | |
// +------------------------------------+----------------------------------------------------------------------------------+
// +------------------------------------+----------------------------------------------------------------------------------+
// | ERROR_ACCESS_DENIED 0x00000005 | Access is denied. The client's fax user account does not have the FAX_CONFIG_SET |
// | | access rights. |
// +------------------------------------+----------------------------------------------------------------------------------+
// | ERROR_INVALID_PARAMETER 0x00000057 | The parameter is incorrect. This error code is returned under any of the |
// | | following conditions: § The value specified for the Buffer parameter is NULL. § |
// | | The value specified for the BufferSize parameter is 0. |
// +------------------------------------+----------------------------------------------------------------------------------+
//
// Exceptions Thrown: No exceptions are thrown except those that are thrown by the underlying
// RPC protocol, [MS-RPCE].
SetLoggingCategories(context.Context, *SetLoggingCategoriesRequest) (*SetLoggingCategoriesResponse, error)
// The FaxObs_GetTapiLocations (Opnum 26) method is called by the client to retrieve
// the current and other available TAPI locations configured for the server. The TAPI
// locations can be set by the client with the FaxObs_SetTapiLocations (section 3.1.4.2.29)
// method.
//
// A TAPI location is described by a FAX_TAPI_LOCATIONS (section 2.2.88) data structure,
// which includes information such as a friendly name, country code, and area code for
// the respective location. For more information about TAPI see [MSDN-TAPI2.2].
//
// On success, the server MUST allocate memory for and return the data describing its
// current and other available TAPI locations.
//
// The client SHOULD free the buffer.
//
// Return Values: This method MUST return 0x00000000 (ERROR_SUCCESS) for success; otherwise,
// it MUST return one of the following error codes, one of the fax-specific errors that
// are defined in section 2.2.52, or one of the other standard errors defined in [MS-ERREF]
// section 2.2.
//
// +------------------------------------+----------------------------------------------------------------------------------+
// | RETURN | |
// | VALUE/CODE | DESCRIPTION |
// | | |
// +------------------------------------+----------------------------------------------------------------------------------+
// +------------------------------------+----------------------------------------------------------------------------------+
// | ERROR_ACCESS_DENIED 0x00000005 | Access is denied. The client's fax user account does not have the |
// | | FAX_CONFIG_QUERY access rights. |
// +------------------------------------+----------------------------------------------------------------------------------+
// | ERROR_NOT_ENOUGH_MEMORY 0x00000008 | The fax server cannot allocate sufficient memory to hold the data to be returned |
// | | to the client. |
// +------------------------------------+----------------------------------------------------------------------------------+
// | ERROR_INVALID_PARAMETER 0x00000057 | The parameter is incorrect. This error is returned if any of the following |
// | | parameters are set to a NULL pointer value: Buffer or BufferSize.<211> |
// +------------------------------------+----------------------------------------------------------------------------------+
//
// Exceptions Thrown: No exceptions are thrown except those that are thrown by the underlying
// RPC protocol, [MS-RPCE].
GetTAPILocations(context.Context, *GetTAPILocationsRequest) (*GetTAPILocationsResponse, error)
// The FaxObs_SetTapiLocations (Opnum 27) method is called by the client to set the
// current and other available TAPI locations for the server. The TAPI locations can
// be retrieved by the client with the FaxObs_GetTapiLocations (section 3.1.4.2.28)
// method.
//
// A TAPI location is described by a FAX_TAPI_LOCATIONS (section 2.2.88) data structure,
// which includes information such as a friendly name, country code, and area code for
// the respective location. For more information about TAPI, see [MSDN-TAPI2.2].
//
// On success, the server MUST apply the new locations configuration that was requested
// by the client.
//
// Return Values: This method MUST return 0x00000000 (ERROR_SUCCESS) for success; otherwise,
// it MUST return one of the following error codes, one of the fax-specific errors that
// are defined in section 2.2.52, or one of the other standard errors defined in [MS-ERREF]
// section 2.2.
//
// +------------------------------------+----------------------------------------------------------------------------------+
// | RETURN | |
// | VALUE/CODE | DESCRIPTION |
// | | |
// +------------------------------------+----------------------------------------------------------------------------------+
// +------------------------------------+----------------------------------------------------------------------------------+
// | ERROR_ACCESS_DENIED 0x00000005 | Access is denied. The client's fax user account does not have the FAX_CONFIG_SET |
// | | access rights. |
// +------------------------------------+----------------------------------------------------------------------------------+
// | ERROR_INVALID_PARAMETER 0x00000057 | The parameter is incorrect. This error is returned if the Buffer parameter is |
// | | set to a NULL pointer value. |
// +------------------------------------+----------------------------------------------------------------------------------+
//
// Exceptions Thrown: No exceptions are thrown except those that are thrown by the underlying
// RPC protocol, [MS-RPCE].
SetTAPILocations(context.Context, *SetTAPILocationsRequest) (*SetTAPILocationsResponse, error)
// The FaxObs_GetMapiProfiles (Opnum 28) method is called by the client to retrieve
// the names of the current MAPI profiles set for the fax server. For more information
// about MAPI profiles, see [MSDN-MAPIPRF].
//
// On success, the server MUST allocate memory for, and return the list of, the current
// MAPI profile names. They MUST be formatted as a sequence of null-terminated character
// strings, with the sequence terminated by a single empty, null-terminated character
// string.
//
// The client SHOULD free the buffer.
//
// Return Values: This method MUST return 0x00000000 (ERROR_SUCCESS) for success; otherwise,
// it MUST return one of the following error codes, one of the fax-specific errors that
// are defined in section 2.2.52, or one of the other standard errors defined in [MS-ERREF]
// section 2.2.
//
// +------------------------------------+----------------------------------------------------------------------------------+
// | RETURN | |
// | VALUE/CODE | DESCRIPTION |
// | | |
// +------------------------------------+----------------------------------------------------------------------------------+
// +------------------------------------+----------------------------------------------------------------------------------+
// | ERROR_ACCESS_DENIED 0x00000005 | Access is denied. The client's fax user account does not have the |
// | | FAX_CONFIG_QUERY access rights. |
// +------------------------------------+----------------------------------------------------------------------------------+
// | ERROR_INVALID_PARAMETER 0x00000057 | The parameter is incorrect. This error is returned if the MapiProfiles or the |
// | | BufferSize parameters are set to NULL pointer values. <212> |
// +------------------------------------+----------------------------------------------------------------------------------+
//
// Exceptions Thrown: No exceptions are thrown except those that are thrown by the underlying
// RPC protocol, [MS-RPCE].
GetMAPIProfiles(context.Context, *GetMAPIProfilesRequest) (*GetMAPIProfilesResponse, error)
// The FaxObs_StartClientServer (Opnum 29) method is called by the client to register
// itself to receive notifications of fax events from the server.
//
// On success, the server MUST start notifying the client about the occurring fax events.
//
// If the server receives a FaxObs_StartClientServer request for a client machine name
// and client name that are already registered to receive fax event notifications with
// a previously executed FaxObs_StartClientServer call, the fax server MUST consider
// the new request a success and keep the existing fax client registration.
//
// To notify the client about a fax event, the server MUST first open a connection with
// the client by calling the FAX_OpenConnection (section 3.2.4.5) method. Then the fax
// server MUST notify the client by calling the FAX_ClientEventQueue (section 3.2.4.2)
// method. Finally, the server SHOULD close the connection with the client by calling
// the FAX_CloseConnection (section 3.2.4.4) method. <213>
//
// Return Values: This method MUST return 0x00000000 (ERROR_SUCCESS) for success; otherwise,
// it MUST return the following error code, one of the fax-specific errors that are
// defined in section 2.2.52, or one of the other standard errors defined in [MS-ERREF]
// section 2.2.
//
// +------------------------------------+--------------------------------------------------------------------------------+
// | RETURN | |
// | VALUE/CODE | DESCRIPTION |
// | | |
// +------------------------------------+--------------------------------------------------------------------------------+
// +------------------------------------+--------------------------------------------------------------------------------+
// | ERROR_NOT_ENOUGH_MEMORY 0x00000008 | The fax server cannot allocate memory necessary for the fax client connection. |
// +------------------------------------+--------------------------------------------------------------------------------+
//
// Exceptions Thrown: No exceptions are thrown except those that are thrown by the underlying
// RPC protocol, [MS-RPCE].
StartClientServer(context.Context, *StartClientServerRequest) (*StartClientServerResponse, error)
// The client calls FaxObs_GetSecurityDescriptor (Opnum 31) method to retrieve the fax
// security descriptor of the server. The client can set the fax security descriptor
// of the server with the FaxObs_SetSecurityDescriptor (section 3.1.4.2.33) method.
//
// On success, the server MUST allocate memory for the return data buffer and return
// a FAX_SECURITY_DESCRIPTOR (section 2.2.90) structure.
//
// The client SHOULD free the buffer.
//
// Return Values: This method MUST return 0x00000000 (ERROR_SUCCESS) for success; otherwise,
// it MUST return one of the following error codes, one of the fax-specific errors that
// are defined in section 2.2.52, or one of the other standard errors defined in [MS-ERREF]
// section 2.2.
//
// +------------------------------------+----------------------------------------------------------------------------------+
// | RETURN | |
// | VALUE/CODE | DESCRIPTION |
// | | |
// +------------------------------------+----------------------------------------------------------------------------------+
// +------------------------------------+----------------------------------------------------------------------------------+
// | ERROR_ACCESS_DENIED 0x00000005 | Access is denied. The client's fax user account does not have the |
// | | FAX_CONFIG_QUERY access rights. |
// +------------------------------------+----------------------------------------------------------------------------------+
// | ERROR_NOT_ENOUGH_MEMORY 0x00000008 | The server cannot allocate sufficient memory to hold the FAX_SECURITY_DESCRIPTOR |
// | | to be returned to the client. |
// +------------------------------------+----------------------------------------------------------------------------------+
// | ERROR_INVALID_CATEGORY 0x00000075 | The server SHOULD return this error code if the value of the Id parameter is |
// | | greater than 0.<214> |
// +------------------------------------+----------------------------------------------------------------------------------+
//
// Exceptions Thrown: No exceptions are thrown except those that are thrown by the underlying
// RPC protocol, [MS-RPCE].
GetSecurityDescriptor(context.Context, *GetSecurityDescriptorRequest) (*GetSecurityDescriptorResponse, error)
// The client calls FaxObs_SetSecurityDescriptor (Opnum 32) method to set the fax security
// descriptor of the server. The client can retrieve the security descriptor of the
// server with the FaxObs_GetSecurityDescriptor (section 3.1.4.2.32) method.
//
// On success, the server MUST apply the security descriptor described in the submitted
// FAX_SECURITY_DESCRIPTOR (section 2.2.90) structure.
//
// Return Values: This method MUST return 0x00000000 (ERROR_SUCCESS) for success; otherwise,
// it MUST return one of the following error codes, one of the fax-specific errors that
// are defined in section 2.2.52, or one of the other standard errors defined in [MS-ERREF]
// section 2.2.
//
// +------------------------------------+----------------------------------------------------------------------------------+
// | RETURN | |
// | VALUE/CODE | DESCRIPTION |
// | | |
// +------------------------------------+----------------------------------------------------------------------------------+
// +------------------------------------+----------------------------------------------------------------------------------+
// | ERROR_ACCESS_DENIED 0x00000005 | Access is denied. The client's fax user account does not have the FAX_CONFIG_SET |
// | | access rights. |
// +------------------------------------+----------------------------------------------------------------------------------+
// | ERROR_INVALID_DATA 0x0000000D | The security descriptor described by the FAX_SECURITY_DESCRIPTOR pointed at by |
// | | the FaxSecurityDecriptor parameter is invalid. |
// +------------------------------------+----------------------------------------------------------------------------------+
// | ERROR_INVALID_PARAMETER 0x00000057 | The parameter is incorrect. This error code is returned under any of the |
// | | following conditions: § The value of the BufferSize parameter is less than the |
// | | size of the Fixed_Portion block of the FAX_SECURITY_DESCRIPTOR. § An offset |
// | | into the Fixed_Portion block of the FAX_SECURITY_DESCRIPTOR pointed at by the |
// | | FaxSecurityDecriptor points to outside of the buffer. |
// +------------------------------------+----------------------------------------------------------------------------------+
// | ERROR_INVALID_CATEGORY 0x00000075 | The fax server SHOULD return this error if the Id member of the |
// | | FAX_SECURITY_DESCRIPTOR specified by the FaxSecurityDescriptor argument is set |
// | | to a value greater than 0.<215> |
// +------------------------------------+----------------------------------------------------------------------------------+
//
// Exceptions Thrown: No exceptions are thrown except those that are thrown by the underlying
// RPC protocol, [MS-RPCE].
SetSecurityDescriptor(context.Context, *SetSecurityDescriptorRequest) (*SetSecurityDescriptorResponse, error)
// The client calls the FaxObs_GetSecurityDescriptorCount (Opnum 33) method to retrieve
// the total number of fax security descriptors from the server.
//
// On success, the server MUST return the total number of security descriptors. This
// number MUST be 1.
//
// Return Values: This method MUST return 0x00000000 (ERROR_SUCCESS) for success; otherwise,
// it MUST return one of the fax-specific errors that are defined in section 2.2.52
// or one of the other standard errors defined in [MS-ERREF] section 2.2. There are
// no predefined error codes to be returned by this method.
//
// Exceptions Thrown: No exceptions are thrown except those that are thrown by the underlying
// RPC protocol, [MS-RPCE].
GetSecurityDescriptorCount(context.Context, *GetSecurityDescriptorCountRequest) (*GetSecurityDescriptorCountResponse, error)
// The FaxObs_AccessCheck (Opnum 34) method is called by the client to check whether
// the currently logged-on client user account has access permissions to execute specific
// fax operations on the fax server.
//
// Return Values: This method MUST return 0x00000000 (ERROR_SUCCESS) for success; otherwise,
// it MUST return one of the following error codes, one of the fax-specific errors that
// are defined in section 2.2.52, or one of the other standard errors defined in [MS-ERREF]
// section 2.2.
//
// +------------------------------------+----------------------------------------------------------------------------------+
// | RETURN | |
// | VALUE/CODE | DESCRIPTION |
// | | |
// +------------------------------------+----------------------------------------------------------------------------------+
// +------------------------------------+----------------------------------------------------------------------------------+
// | ERROR_INVALID_PARAMETER 0x00000057 | The parameter is incorrect. This error code is returned if any of the following |
// | | conditions are met: § The hBinding parameter is set to a NULL value. <216> § The |
// | | fAccess parameter is set to a NULL pointer value. <217> |
// +------------------------------------+----------------------------------------------------------------------------------+
//
// Exceptions Thrown: No exceptions are thrown except those that are thrown by the underlying
// RPC protocol, [MS-RPCE].
AccessCheck(context.Context, *AccessCheckRequest) (*AccessCheckResponse, error)
}
faxobs server interface.
type GetConfigurationRequest ¶
type GetConfigurationRequest struct {
// Buffer: A pointer to the address of the returned buffer containing a _FAX_CONFIGURATIONW
// (section 2.2.29) structure. The structure contains the current configuration settings
// for the fax server.
Buffer []byte `idl:"name:Buffer;size_is:(, BufferSize);pointer:unique" json:"buffer"`
// BufferSize: A variable to return the size, in bytes, of the buffer.
BufferSize uint32 `idl:"name:BufferSize" json:"buffer_size"`
}
GetConfigurationRequest structure represents the FaxObs_GetConfiguration operation request
func (*GetConfigurationRequest) MarshalNDR ¶
func (*GetConfigurationRequest) UnmarshalNDR ¶
type GetConfigurationResponse ¶
type GetConfigurationResponse struct {
// Buffer: A pointer to the address of the returned buffer containing a _FAX_CONFIGURATIONW
// (section 2.2.29) structure. The structure contains the current configuration settings
// for the fax server.
Buffer []byte `idl:"name:Buffer;size_is:(, BufferSize);pointer:unique" json:"buffer"`
// BufferSize: A variable to return the size, in bytes, of the buffer.
BufferSize uint32 `idl:"name:BufferSize" json:"buffer_size"`
// Return: The FaxObs_GetConfiguration return value.
Return uint32 `idl:"name:Return" json:"return"`
}
GetConfigurationResponse structure represents the FaxObs_GetConfiguration operation response
func (*GetConfigurationResponse) MarshalNDR ¶
func (*GetConfigurationResponse) UnmarshalNDR ¶
type GetDeviceStatusRequest ¶
type GetDeviceStatusRequest struct {
// FaxPortHandle: An RPC context handle that references a specified fax port. This context
// handle MUST be obtained using the FaxObs_OpenPort (section 3.1.4.2.5) method.
FaxPort *fax.Port `idl:"name:FaxPortHandle" json:"fax_port"`
// StatusBuffer: A pointer to the address of the returned buffer containing a FAX_DEVICE_STATUS
// (section 2.2.10) structure. The structure describes the status of one fax device.
StatusBuffer []byte `idl:"name:StatusBuffer;size_is:(, BufferSize);pointer:unique" json:"status_buffer"`
// BufferSize: A variable to return the size, in bytes, of the status buffer.
BufferSize uint32 `idl:"name:BufferSize" json:"buffer_size"`
}
GetDeviceStatusRequest structure represents the FaxObs_GetDeviceStatus operation request
func (*GetDeviceStatusRequest) MarshalNDR ¶
func (*GetDeviceStatusRequest) UnmarshalNDR ¶
type GetDeviceStatusResponse ¶
type GetDeviceStatusResponse struct {
// StatusBuffer: A pointer to the address of the returned buffer containing a FAX_DEVICE_STATUS
// (section 2.2.10) structure. The structure describes the status of one fax device.
StatusBuffer []byte `idl:"name:StatusBuffer;size_is:(, BufferSize);pointer:unique" json:"status_buffer"`
// BufferSize: A variable to return the size, in bytes, of the status buffer.
BufferSize uint32 `idl:"name:BufferSize" json:"buffer_size"`
// Return: The FaxObs_GetDeviceStatus return value.
Return uint32 `idl:"name:Return" json:"return"`
}
GetDeviceStatusResponse structure represents the FaxObs_GetDeviceStatus operation response
func (*GetDeviceStatusResponse) MarshalNDR ¶
func (*GetDeviceStatusResponse) UnmarshalNDR ¶
type GetInstallTypeRequest ¶
type GetInstallTypeRequest struct {
}
GetInstallTypeRequest structure represents the FaxObs_GetInstallType operation request
func (*GetInstallTypeRequest) MarshalNDR ¶
func (*GetInstallTypeRequest) UnmarshalNDR ¶
type GetInstallTypeResponse ¶
type GetInstallTypeResponse struct {
// InstallType: A pointer to a DWORD ([MS-DTYP] section 2.2.9) value where, upon return
// from this call, the fax server MUST write the install type of the fax server. This
// value MUST be 0x00000002 for FAX_INSTALL_SERVER. The values 0x00000001, 0x00000004,
// and 0x00000008 are reserved for local use.
InstallType uint32 `idl:"name:InstallType" json:"install_type"`
// InstalledPlatforms: A pointer to a DWORD value where on return from this call, the
// fax server MUST write the installed platform (microprocessor type) of the fax server.
// This value MUST be one of the following:
//
// +-----------------------------------------+-----------------------------------------------------+
// | | |
// | VALUE/CODE | MEANING |
// | | |
// +-----------------------------------------+-----------------------------------------------------+
// +-----------------------------------------+-----------------------------------------------------+
// | FAX_INSTALLED_PLATFORM_X86 0x00000001 | The fax server is running on an Intel x86 platform. |
// +-----------------------------------------+-----------------------------------------------------+
// | FAX_INSTALLED_PLATFORM_MIPS 0x00000002 | The fax server is running on a MIPS platform. |
// +-----------------------------------------+-----------------------------------------------------+
// | FAX_INSTALLED_PLATFORM_ALPHA 0x00000004 | The fax server is running on a DEC Alpha platform. |
// +-----------------------------------------+-----------------------------------------------------+
// | FAX_INSTALLED_PLATFORM_PPC 0x00000008 | The fax server is running on a PowerPC platform. |
// +-----------------------------------------+-----------------------------------------------------+
InstalledPlatforms uint32 `idl:"name:InstalledPlatforms" json:"installed_platforms"`
// ProductType: A pointer to a DWORD value where on return from this call, the fax server
// MUST write the installed product type of the fax server. This value MUST be one of
// the following:
//
// +--------------------------------+--------------------------------------------------------+
// | | |
// | VALUE/CODE | MEANING |
// | | |
// +--------------------------------+--------------------------------------------------------+
// +--------------------------------+--------------------------------------------------------+
// | PRODUCT_TYPE_WINNT 0x00000001 | The fax server is a workstation-type operating system. |
// +--------------------------------+--------------------------------------------------------+
// | PRODUCT_TYPE_SERVER 0x00000002 | The fax server is a server-type operating system. |
// +--------------------------------+--------------------------------------------------------+
ProductType uint32 `idl:"name:ProductType" json:"product_type"`
// Return: The FaxObs_GetInstallType return value.
Return uint32 `idl:"name:Return" json:"return"`
}
GetInstallTypeResponse structure represents the FaxObs_GetInstallType operation response
func (*GetInstallTypeResponse) MarshalNDR ¶
func (*GetInstallTypeResponse) UnmarshalNDR ¶
type GetJobRequest ¶
type GetJobRequest struct {
// JobId: A number that uniquely identifies a queued or active fax job on the server.
JobID uint32 `idl:"name:JobId" json:"job_id"`
// Buffer: A pointer to the address of the returned buffer containing a _FAX_JOB_ENTRY
// (section 2.2.6) structure.
Buffer []byte `idl:"name:Buffer;size_is:(, BufferSize);pointer:unique" json:"buffer"`
// BufferSize: A variable to return the size, in bytes, of the job information buffer.
BufferSize uint32 `idl:"name:BufferSize" json:"buffer_size"`
}
GetJobRequest structure represents the FaxObs_GetJob operation request
func (*GetJobRequest) MarshalNDR ¶
func (*GetJobRequest) UnmarshalNDR ¶
type GetJobResponse ¶
type GetJobResponse struct {
// Buffer: A pointer to the address of the returned buffer containing a _FAX_JOB_ENTRY
// (section 2.2.6) structure.
Buffer []byte `idl:"name:Buffer;size_is:(, BufferSize);pointer:unique" json:"buffer"`
// BufferSize: A variable to return the size, in bytes, of the job information buffer.
BufferSize uint32 `idl:"name:BufferSize" json:"buffer_size"`
// Return: The FaxObs_GetJob return value.
Return uint32 `idl:"name:Return" json:"return"`
}
GetJobResponse structure represents the FaxObs_GetJob operation response
func (*GetJobResponse) MarshalNDR ¶
func (*GetJobResponse) UnmarshalNDR ¶
type GetLoggingCategoriesRequest ¶
type GetLoggingCategoriesRequest struct {
// Buffer: A pointer to the address of the returned buffer containing an array of FAX_LOG_CATEGORY
// (section 2.2.11) structures. The number of structures included in the array is set
// by NumberCategories. Each structure describes one current logging category. The Name
// strings are appended after the FAX_LOG_CATEGORY entries.
Buffer []byte `idl:"name:Buffer;size_is:(, BufferSize);pointer:unique" json:"buffer"`
// BufferSize: A variable to return the size, in bytes, of the buffer.
BufferSize uint32 `idl:"name:BufferSize" json:"buffer_size"`
// NumberCategories: A pointer to a DWORD ([MS-DTYP] section 2.2.9) variable to receive
// the number of FAX_LOG_CATEGORY structures that the method returns in the Buffer parameter.
NumberCategories uint32 `idl:"name:NumberCategories" json:"number_categories"`
}
GetLoggingCategoriesRequest structure represents the FaxObs_GetLoggingCategories operation request
func (*GetLoggingCategoriesRequest) MarshalNDR ¶
func (*GetLoggingCategoriesRequest) UnmarshalNDR ¶
type GetLoggingCategoriesResponse ¶
type GetLoggingCategoriesResponse struct {
// Buffer: A pointer to the address of the returned buffer containing an array of FAX_LOG_CATEGORY
// (section 2.2.11) structures. The number of structures included in the array is set
// by NumberCategories. Each structure describes one current logging category. The Name
// strings are appended after the FAX_LOG_CATEGORY entries.
Buffer []byte `idl:"name:Buffer;size_is:(, BufferSize);pointer:unique" json:"buffer"`
// BufferSize: A variable to return the size, in bytes, of the buffer.
BufferSize uint32 `idl:"name:BufferSize" json:"buffer_size"`
// NumberCategories: A pointer to a DWORD ([MS-DTYP] section 2.2.9) variable to receive
// the number of FAX_LOG_CATEGORY structures that the method returns in the Buffer parameter.
NumberCategories uint32 `idl:"name:NumberCategories" json:"number_categories"`
// Return: The FaxObs_GetLoggingCategories return value.
Return uint32 `idl:"name:Return" json:"return"`
}
GetLoggingCategoriesResponse structure represents the FaxObs_GetLoggingCategories operation response
func (*GetLoggingCategoriesResponse) MarshalNDR ¶
func (*GetLoggingCategoriesResponse) UnmarshalNDR ¶
type GetMAPIProfilesRequest ¶
type GetMAPIProfilesRequest struct {
// MapiProfiles: A pointer to the address of the returned buffer. This buffer contains
// a sequence of null-terminated character strings; each of these strings contains the
// name of a MAPI profile. The sequence is terminated by an empty null-terminated character
// string.
MAPIProfiles []byte `idl:"name:MapiProfiles;size_is:(, BufferSize);pointer:unique" json:"mapi_profiles"`
// BufferSize: Pointer to a DWORD ([MS-DTYP] section 2.2.9) variable that receives the
// size, in bytes, of the data returned in the MapiProfiles character strings sequence.
BufferSize uint32 `idl:"name:BufferSize" json:"buffer_size"`
}
GetMAPIProfilesRequest structure represents the FaxObs_GetMapiProfiles operation request
func (*GetMAPIProfilesRequest) MarshalNDR ¶
func (*GetMAPIProfilesRequest) UnmarshalNDR ¶
type GetMAPIProfilesResponse ¶
type GetMAPIProfilesResponse struct {
// MapiProfiles: A pointer to the address of the returned buffer. This buffer contains
// a sequence of null-terminated character strings; each of these strings contains the
// name of a MAPI profile. The sequence is terminated by an empty null-terminated character
// string.
MAPIProfiles []byte `idl:"name:MapiProfiles;size_is:(, BufferSize);pointer:unique" json:"mapi_profiles"`
// BufferSize: Pointer to a DWORD ([MS-DTYP] section 2.2.9) variable that receives the
// size, in bytes, of the data returned in the MapiProfiles character strings sequence.
BufferSize uint32 `idl:"name:BufferSize" json:"buffer_size"`
// Return: The FaxObs_GetMapiProfiles return value.
Return uint32 `idl:"name:Return" json:"return"`
}
GetMAPIProfilesResponse structure represents the FaxObs_GetMapiProfiles operation response
func (*GetMAPIProfilesResponse) MarshalNDR ¶
func (*GetMAPIProfilesResponse) UnmarshalNDR ¶
type GetPageDataRequest ¶
type GetPageDataRequest struct {
// JobId: A DWORD ([MS-DTYP] section 2.2.9) containing the unique number identifying
// the fax job that is associated with the page of data.
JobID uint32 `idl:"name:JobId" json:"job_id"`
// Buffer: A pointer to the address of the returned buffer containing the first page
// of data in the fax document.
Buffer []byte `idl:"name:Buffer;size_is:(, BufferSize);pointer:unique" json:"buffer"`
// BufferSize: A pointer to a DWORD variable to receive the size, in bytes, of the buffer
// pointed to by the Buffer parameter.
BufferSize uint32 `idl:"name:BufferSize" json:"buffer_size"`
// ImageWidth: A pointer to a DWORD variable to receive the width, in pixels, of the
// fax image.
ImageWidth uint32 `idl:"name:ImageWidth" json:"image_width"`
// ImageHeight: A pointer to a DWORD variable to receive the height, in pixels, of the
// fax image.
ImageHeight uint32 `idl:"name:ImageHeight" json:"image_height"`
}
GetPageDataRequest structure represents the FaxObs_GetPageData operation request
func (*GetPageDataRequest) MarshalNDR ¶
func (*GetPageDataRequest) UnmarshalNDR ¶
type GetPageDataResponse ¶
type GetPageDataResponse struct {
// Buffer: A pointer to the address of the returned buffer containing the first page
// of data in the fax document.
Buffer []byte `idl:"name:Buffer;size_is:(, BufferSize);pointer:unique" json:"buffer"`
// BufferSize: A pointer to a DWORD variable to receive the size, in bytes, of the buffer
// pointed to by the Buffer parameter.
BufferSize uint32 `idl:"name:BufferSize" json:"buffer_size"`
// ImageWidth: A pointer to a DWORD variable to receive the width, in pixels, of the
// fax image.
ImageWidth uint32 `idl:"name:ImageWidth" json:"image_width"`
// ImageHeight: A pointer to a DWORD variable to receive the height, in pixels, of the
// fax image.
ImageHeight uint32 `idl:"name:ImageHeight" json:"image_height"`
// Return: The FaxObs_GetPageData return value.
Return uint32 `idl:"name:Return" json:"return"`
}
GetPageDataResponse structure represents the FaxObs_GetPageData operation response
func (*GetPageDataResponse) MarshalNDR ¶
func (*GetPageDataResponse) UnmarshalNDR ¶
type GetPortRequest ¶
type GetPortRequest struct {
// FaxPortHandle: An RPC context handle that references a fax port.
FaxPort *fax.Port `idl:"name:FaxPortHandle" json:"fax_port"`
// PortBuffer: A pointer to the address of the returned buffer containing a _FAX_PORT_INFO
// (section 2.2.8) structure. The structure describes one fax port (device).
PortBuffer []byte `idl:"name:PortBuffer;size_is:(, BufferSize);pointer:unique" json:"port_buffer"`
// BufferSize: A variable to return the size, in bytes, of the port buffer.
BufferSize uint32 `idl:"name:BufferSize" json:"buffer_size"`
}
GetPortRequest structure represents the FaxObs_GetPort operation request
func (*GetPortRequest) MarshalNDR ¶
func (*GetPortRequest) UnmarshalNDR ¶
type GetPortResponse ¶
type GetPortResponse struct {
// PortBuffer: A pointer to the address of the returned buffer containing a _FAX_PORT_INFO
// (section 2.2.8) structure. The structure describes one fax port (device).
PortBuffer []byte `idl:"name:PortBuffer;size_is:(, BufferSize);pointer:unique" json:"port_buffer"`
// BufferSize: A variable to return the size, in bytes, of the port buffer.
BufferSize uint32 `idl:"name:BufferSize" json:"buffer_size"`
// Return: The FaxObs_GetPort return value.
Return uint32 `idl:"name:Return" json:"return"`
}
GetPortResponse structure represents the FaxObs_GetPort operation response
func (*GetPortResponse) MarshalNDR ¶
func (*GetPortResponse) UnmarshalNDR ¶
type GetQueueFileNameRequest ¶
type GetQueueFileNameRequest struct {
// FileName: A buffer that MUST be allocated by the client to hold FileNameSize characters.
// On successful return from this call the server MUST write to this buffer a null-terminated
// character string containing the path name, including file name and extension, for
// a new unique file name within the fax server queue directory.<192>
FileName string `idl:"name:FileName;size_is:(FileNameSize);pointer:unique" json:"file_name"`
// FileNameSize: A DWORD ([MS-DTYP] section 2.2.9) value that specifies the size, in
// characters, of the FileName buffer.<193>
FileNameSize uint32 `idl:"name:FileNameSize" json:"file_name_size"`
}
GetQueueFileNameRequest structure represents the FaxObs_GetQueueFileName operation request
func (*GetQueueFileNameRequest) MarshalNDR ¶
func (*GetQueueFileNameRequest) UnmarshalNDR ¶
type GetQueueFileNameResponse ¶
type GetQueueFileNameResponse struct {
// FileName: A buffer that MUST be allocated by the client to hold FileNameSize characters.
// On successful return from this call the server MUST write to this buffer a null-terminated
// character string containing the path name, including file name and extension, for
// a new unique file name within the fax server queue directory.<192>
FileName string `idl:"name:FileName;size_is:(FileNameSize);pointer:unique" json:"file_name"`
// Return: The FaxObs_GetQueueFileName return value.
Return uint32 `idl:"name:Return" json:"return"`
}
GetQueueFileNameResponse structure represents the FaxObs_GetQueueFileName operation response
func (*GetQueueFileNameResponse) MarshalNDR ¶
func (*GetQueueFileNameResponse) UnmarshalNDR ¶
type GetRoutingInfoRequest ¶
type GetRoutingInfoRequest struct {
// FaxPortHandle: An RPC context handle that references a specified fax port.
FaxPort *fax.Port `idl:"name:FaxPortHandle" json:"fax_port"`
// RoutingGuid: A curly braced GUID string that uniquely identifies the fax routing
// method for which to obtain the routing information. Fax routing methods are defined
// by a fax-routing extension and each method is identified by a GUID. For more information
// about routing methods, see [MSDN-FRM]. The routing methods and their curly braced
// GUID string values that can be used for this parameter are discoverable by calling
// FaxObs_EnumRoutingMethods (section 3.1.4.2.18). Included in this list are the default
// routing methods described in section 2.2.87.
RoutingGUID string `idl:"name:RoutingGuid;string;pointer:unique" json:"routing_guid"`
// RoutingInfoBuffer: A pointer to the address of the returned buffer containing the
// fax-routing information. The buffer format and contents depend on the routing method
// that is identified by RoutingGuid.
RoutingInfoBuffer []byte `idl:"name:RoutingInfoBuffer;size_is:(, RoutingInfoBufferSize);pointer:unique" json:"routing_info_buffer"`
// RoutingInfoBufferSize: A pointer to a DWORD ([MS-DTYP] section 2.2.9) variable that
// receives the size, in bytes, of the RoutingInfoBuffer buffer.
RoutingInfoBufferSize uint32 `idl:"name:RoutingInfoBufferSize" json:"routing_info_buffer_size"`
}
GetRoutingInfoRequest structure represents the FaxObs_GetRoutingInfo operation request
func (*GetRoutingInfoRequest) MarshalNDR ¶
func (*GetRoutingInfoRequest) UnmarshalNDR ¶
type GetRoutingInfoResponse ¶
type GetRoutingInfoResponse struct {
// RoutingInfoBuffer: A pointer to the address of the returned buffer containing the
// fax-routing information. The buffer format and contents depend on the routing method
// that is identified by RoutingGuid.
RoutingInfoBuffer []byte `idl:"name:RoutingInfoBuffer;size_is:(, RoutingInfoBufferSize);pointer:unique" json:"routing_info_buffer"`
// RoutingInfoBufferSize: A pointer to a DWORD ([MS-DTYP] section 2.2.9) variable that
// receives the size, in bytes, of the RoutingInfoBuffer buffer.
RoutingInfoBufferSize uint32 `idl:"name:RoutingInfoBufferSize" json:"routing_info_buffer_size"`
// Return: The FaxObs_GetRoutingInfo return value.
Return uint32 `idl:"name:Return" json:"return"`
}
GetRoutingInfoResponse structure represents the FaxObs_GetRoutingInfo operation response
func (*GetRoutingInfoResponse) MarshalNDR ¶
func (*GetRoutingInfoResponse) UnmarshalNDR ¶
type GetSecurityDescriptorCountRequest ¶
type GetSecurityDescriptorCountRequest struct {
}
GetSecurityDescriptorCountRequest structure represents the FaxObs_GetSecurityDescriptorCount operation request
func (*GetSecurityDescriptorCountRequest) MarshalNDR ¶
func (*GetSecurityDescriptorCountRequest) UnmarshalNDR ¶
type GetSecurityDescriptorCountResponse ¶
type GetSecurityDescriptorCountResponse struct {
// Count: A pointer to a DWORD ([MS-DTYP] section 2.2.9) value containing on return
// the number of security descriptors. On a successful return, the server MUST set this
// parameter to a value of 1.
Count uint32 `idl:"name:Count" json:"count"`
// Return: The FaxObs_GetSecurityDescriptorCount return value.
Return uint32 `idl:"name:Return" json:"return"`
}
GetSecurityDescriptorCountResponse structure represents the FaxObs_GetSecurityDescriptorCount operation response
func (*GetSecurityDescriptorCountResponse) MarshalNDR ¶
func (*GetSecurityDescriptorCountResponse) UnmarshalNDR ¶
type GetSecurityDescriptorRequest ¶
type GetSecurityDescriptorRequest struct {
// Id: A DWORD ([MS-DTYP] section 2.2.9) containing the identifier of the security descriptor
// to request. The client MUST set this parameter to 0.
ID uint32 `idl:"name:Id" json:"id"`
// FaxSecurityDescriptor: A pointer to the address of the returned buffer containing
// a FAX_SECURITY_DESCRIPTOR.
FaxSecurityDescriptor []byte `idl:"name:FaxSecurityDescriptor;size_is:(, BufferSize);pointer:unique" json:"fax_security_descriptor"`
// BufferSize: Pointer to a DWORD variable containing the number of bytes returned in
// the FaxSecurityDescriptor buffer.
BufferSize uint32 `idl:"name:BufferSize" json:"buffer_size"`
}
GetSecurityDescriptorRequest structure represents the FaxObs_GetSecurityDescriptor operation request
func (*GetSecurityDescriptorRequest) MarshalNDR ¶
func (*GetSecurityDescriptorRequest) UnmarshalNDR ¶
type GetSecurityDescriptorResponse ¶
type GetSecurityDescriptorResponse struct {
// FaxSecurityDescriptor: A pointer to the address of the returned buffer containing
// a FAX_SECURITY_DESCRIPTOR.
FaxSecurityDescriptor []byte `idl:"name:FaxSecurityDescriptor;size_is:(, BufferSize);pointer:unique" json:"fax_security_descriptor"`
// BufferSize: Pointer to a DWORD variable containing the number of bytes returned in
// the FaxSecurityDescriptor buffer.
BufferSize uint32 `idl:"name:BufferSize" json:"buffer_size"`
// Return: The FaxObs_GetSecurityDescriptor return value.
Return uint32 `idl:"name:Return" json:"return"`
}
GetSecurityDescriptorResponse structure represents the FaxObs_GetSecurityDescriptor operation response
func (*GetSecurityDescriptorResponse) MarshalNDR ¶
func (*GetSecurityDescriptorResponse) UnmarshalNDR ¶
type GetTAPILocationsRequest ¶
type GetTAPILocationsRequest struct {
// Buffer: A pointer to the address of the returned buffer containing a FAX_TAPI_LOCATION_INFO
// (section 2.2.89) structure that contains a list of FAX_TAPI_LOCATIONS, each FAX_TAPI_LOCATIONS
// describes one location. Each structure includes information such as a friendly name,
// country code, and area code. The current location can be identified in this list
// of FAX_TAPI_LOCATIONS by searching for a structure with the location identifier value
// (contained by the PermanentLocationID member) described by the CurrentLocationID
// member of the FAX_TAPI_LOCATION_INFO.
Buffer []byte `idl:"name:Buffer;size_is:(, BufferSize);pointer:unique" json:"buffer"`
// BufferSize: Pointer to a DWORD ([MS-DTYP] section 2.2.9) variable that receives the
// size, in bytes, of the data returned in the buffer.
BufferSize uint32 `idl:"name:BufferSize" json:"buffer_size"`
}
GetTAPILocationsRequest structure represents the FaxObs_GetTapiLocations operation request
func (*GetTAPILocationsRequest) MarshalNDR ¶
func (*GetTAPILocationsRequest) UnmarshalNDR ¶
type GetTAPILocationsResponse ¶
type GetTAPILocationsResponse struct {
// Buffer: A pointer to the address of the returned buffer containing a FAX_TAPI_LOCATION_INFO
// (section 2.2.89) structure that contains a list of FAX_TAPI_LOCATIONS, each FAX_TAPI_LOCATIONS
// describes one location. Each structure includes information such as a friendly name,
// country code, and area code. The current location can be identified in this list
// of FAX_TAPI_LOCATIONS by searching for a structure with the location identifier value
// (contained by the PermanentLocationID member) described by the CurrentLocationID
// member of the FAX_TAPI_LOCATION_INFO.
Buffer []byte `idl:"name:Buffer;size_is:(, BufferSize);pointer:unique" json:"buffer"`
// BufferSize: Pointer to a DWORD ([MS-DTYP] section 2.2.9) variable that receives the
// size, in bytes, of the data returned in the buffer.
BufferSize uint32 `idl:"name:BufferSize" json:"buffer_size"`
// Return: The FaxObs_GetTapiLocations return value.
Return uint32 `idl:"name:Return" json:"return"`
}
GetTAPILocationsResponse structure represents the FaxObs_GetTapiLocations operation response
func (*GetTAPILocationsResponse) MarshalNDR ¶
func (*GetTAPILocationsResponse) UnmarshalNDR ¶
type GetVersionRequest ¶
type GetVersionRequest struct {
}
GetVersionRequest structure represents the FaxObs_GetVersion operation request
func (*GetVersionRequest) MarshalNDR ¶
func (*GetVersionRequest) UnmarshalNDR ¶
type GetVersionResponse ¶
type GetVersionResponse struct {
// Version: A pointer to a DWORD ([MS-DTYP] section 2.2.9) value where on return from
// this call, the server MUST write its version number. The server MUST write to the
// low-order WORD ([MS-DTYP] section 2.2.61) of this DWORD value the major version number
// and to the high-order WORD the minor version number. The returned DWORD value format
// is as follows:
//
// +---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+
// | 0 | 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 1 | 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 2 | 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 3 | 1 |
// | | | | | | | | | | | 0 | | | | | | | | | | 0 | | | | | | | | | | 0 | |
// +---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+
// +---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+
// | Minor version number | Major version number |
// +---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+
Version uint32 `idl:"name:Version" json:"version"`
// Return: The FaxObs_GetVersion return value.
Return uint32 `idl:"name:Return" json:"return"`
}
GetVersionResponse structure represents the FaxObs_GetVersion operation response
func (*GetVersionResponse) MarshalNDR ¶
func (*GetVersionResponse) UnmarshalNDR ¶
type OpenPortRequest ¶
type OpenPortRequest struct {
// DeviceId: A DWORD ([MS-DTYP] section 2.2.9) variable that contains the line identifier
// for the receiving device (port). The client SHOULD call the FaxObs_EnumPorts (section
// 3.1.4.2.15) method to retrieve a valid value for this parameter.
DeviceID uint32 `idl:"name:DeviceId" json:"device_id"`
// Flags: A DWORD variable that contains a set of bit flags defining the access mode
// for the port.<185>
//
// +-----------------------------+----------------------------------------------------------------------------------+
// | | |
// | VALUE/CODE | MEANING |
// | | |
// +-----------------------------+----------------------------------------------------------------------------------+
// +-----------------------------+----------------------------------------------------------------------------------+
// | 0x00000000 | No port access mode flags are specified. |
// +-----------------------------+----------------------------------------------------------------------------------+
// | PORT_OPEN_QUERY 0x00000001 | The port access mode that is required to obtain a fax port handle. This access |
// | | level is also required to call the FaxObs_GetPort (section 3.1.4.2.16) method to |
// | | query fax port information.<186> |
// +-----------------------------+----------------------------------------------------------------------------------+
// | PORT_OPEN_MODIFY 0x00000002 | The port access mode that allows changes to the configuration of a fax |
// | | port. The fax server can use this port access mode to allow execution of the |
// | | FaxObs_SetPort (section 3.1.4.2.17) method. This access mode also includes the |
// | | allowance that is associated with the PORT_OPEN_QUERY access mode.<187> |
// +-----------------------------+----------------------------------------------------------------------------------+
Flags uint32 `idl:"name:Flags" json:"flags"`
}
OpenPortRequest structure represents the FaxObs_OpenPort operation request
func (*OpenPortRequest) MarshalNDR ¶
func (*OpenPortRequest) UnmarshalNDR ¶
type OpenPortResponse ¶
type OpenPortResponse struct {
// FaxPortHandle: A pointer to a variable that receives a fax port handle (from the
// Fax Data Types (section 2.2.74) enumeration) that is required on subsequent calls
// by other fax client methods.
FaxPort *fax.Port `idl:"name:FaxPortHandle" json:"fax_port"`
// Return: The FaxObs_OpenPort return value.
Return uint32 `idl:"name:Return" json:"return"`
}
OpenPortResponse structure represents the FaxObs_OpenPort operation response
func (*OpenPortResponse) MarshalNDR ¶
func (*OpenPortResponse) UnmarshalNDR ¶
type SendDocumentRequest ¶
type SendDocumentRequest struct {
// FileName: A null-terminated character string that contains the name of the file,
// without path information, of the fax document in TIFF format. The server checks the
// server queue directory for this file. Before making this call, the client can create
// a file on the server by calling FaxObs_GetQueueFileName (section 3.1.4.2.8) and then
// provide content for the file by using a protocol outside of this specification, such
// as [MS-SMB].
FileName string `idl:"name:FileName;string;pointer:unique" json:"file_name"`
// JobParams: A pointer to a FAX_JOB_PARAMW (section 2.2.13) structure that contains
// the information necessary for the server to send the fax transmission, including
// information describing the personal profiles (section 3.1.1) for the sender and the
// recipient of the fax.
JobParams *fax.JobParamW `idl:"name:JobParams" json:"job_params"`
}
SendDocumentRequest structure represents the FaxObs_SendDocument operation request
func (*SendDocumentRequest) MarshalNDR ¶
func (*SendDocumentRequest) UnmarshalNDR ¶
type SendDocumentResponse ¶
type SendDocumentResponse struct {
// FaxJobId: A pointer to a DWORD ([MS-DTYP] section 2.2.9) that returns the job ID.
FaxJobID uint32 `idl:"name:FaxJobId" json:"fax_job_id"`
// Return: The FaxObs_SendDocument return value.
Return uint32 `idl:"name:Return" json:"return"`
}
SendDocumentResponse structure represents the FaxObs_SendDocument operation response
func (*SendDocumentResponse) MarshalNDR ¶
func (*SendDocumentResponse) UnmarshalNDR ¶
type SetConfigurationRequest ¶
type SetConfigurationRequest struct {
// FaxConfig: A pointer to a FAX_CONFIGURATIONW (section 2.2.28) structure. If the Branding
// structure member is TRUE, the fax server SHOULD generate a brand that contains transmission-related
// information, such as the transmitting subscriber identifier, date, time, and page
// count. If the UseDeviceTsid structure member is TRUE, the server SHOULD use the device's
// transmitting subscriber identifier. If the ServerCp structure member is TRUE, the
// client SHOULD use a common cover page stored on the fax server; if this member is
// FALSE, the client SHOULD use a personal cover page template. If the PauseServerQueue
// structure member is TRUE, the server SHOULD pause the outgoing fax queue. If the
// ArchiveOutgoingFaxes structure member is TRUE, the server SHOULD archive transmissions
// in the directory specified by the ArchiveDirectory member. The fax server SHOULD
// ignore the ArchiveDirectory structure member if the ArchiveOutgoingFaxes member is
// FALSE. The fax server SHOULD retain the discount time period submitted by the client
// with the StartCheapTime and StopCheapTime structure members. <209>
FaxConfig *fax.ConfigW `idl:"name:FaxConfig" json:"fax_config"`
}
SetConfigurationRequest structure represents the FaxObs_SetConfiguration operation request
func (*SetConfigurationRequest) MarshalNDR ¶
func (*SetConfigurationRequest) UnmarshalNDR ¶
type SetConfigurationResponse ¶
type SetConfigurationResponse struct {
// Return: The FaxObs_SetConfiguration return value.
Return uint32 `idl:"name:Return" json:"return"`
}
SetConfigurationResponse structure represents the FaxObs_SetConfiguration operation response
func (*SetConfigurationResponse) MarshalNDR ¶
func (*SetConfigurationResponse) UnmarshalNDR ¶
type SetGlobalRoutingInfoRequest ¶
type SetGlobalRoutingInfoRequest struct {
// RoutingInfo: A pointer to a buffer that contains a FAX_GLOBAL_ROUTING_INFOW (section
// 2.2.32) structure.
RoutingInfo *fax.GlobalRoutingInfoW `idl:"name:RoutingInfo" json:"routing_info"`
}
SetGlobalRoutingInfoRequest structure represents the FaxObs_SetGlobalRoutingInfo operation request
func (*SetGlobalRoutingInfoRequest) MarshalNDR ¶
func (*SetGlobalRoutingInfoRequest) UnmarshalNDR ¶
type SetGlobalRoutingInfoResponse ¶
type SetGlobalRoutingInfoResponse struct {
// Return: The FaxObs_SetGlobalRoutingInfo return value.
Return uint32 `idl:"name:Return" json:"return"`
}
SetGlobalRoutingInfoResponse structure represents the FaxObs_SetGlobalRoutingInfo operation response
func (*SetGlobalRoutingInfoResponse) MarshalNDR ¶
func (*SetGlobalRoutingInfoResponse) UnmarshalNDR ¶
type SetJobRequest ¶
type SetJobRequest struct {
// JobId: A DWORD ([MS-DTYP] section 2.2.9) containing a value that uniquely identifies
// the fax job to modify.
JobID uint32 `idl:"name:JobId" json:"job_id"`
// Command: A DWORD containing a job command that the fax server is requested to perform.
//
// +----------------------+----------------------------------------------------------------------------------+
// | | |
// | VALUE/CODE | MEANING |
// | | |
// +----------------------+----------------------------------------------------------------------------------+
// +----------------------+----------------------------------------------------------------------------------+
// | JC_DELETE 0x00000001 | The fax server MUST cancel the specified fax job. This job can be in an active |
// | | or queued state. This is equivalent to calling the FaxObs_Abort (section |
// | | 3.1.4.2.14) method. |
// +----------------------+----------------------------------------------------------------------------------+
// | JC_PAUSE 0x00000002 | The fax server MUST pause the specified fax job if the job's status is |
// | | JS_PENDING or JS_RETRYING. |
// +----------------------+----------------------------------------------------------------------------------+
// | JC_RESUME 0x00000003 | The fax server MUST resume the specified fax job if it is in a paused state and |
// | | return the job status to the value it had when the job was paused: JS_PENDING or |
// | | JS_RETRYING. |
// +----------------------+----------------------------------------------------------------------------------+
Command uint32 `idl:"name:Command" json:"command"`
// JobEntry: A pointer to a FAX_JOB_ENTRY (section 2.2.5) structure. The fax server
// MUST validate this pointer to be not NULL and fail to return ERROR_INVALID_PARAMETER
// otherwise. Except for this validation requirement, the fax server SHOULD ignore this
// parameter. The fax client SHOULD submit the pointer to a valid FAX_JOB_ENTRY. This
// structure contains data obtained from FaxObs_GetJob (section 3.1.4.2.10) or FaxObs_EnumJobs
// (section 3.1.4.2.9). This data represents the job identified by the JobId parameter.<196>
JobEntry *fax.JobEntry `idl:"name:JobEntry" json:"job_entry"`
}
SetJobRequest structure represents the FaxObs_SetJob operation request
func (*SetJobRequest) MarshalNDR ¶
func (*SetJobRequest) UnmarshalNDR ¶
type SetJobResponse ¶
type SetJobResponse struct {
// Return: The FaxObs_SetJob return value.
Return uint32 `idl:"name:Return" json:"return"`
}
SetJobResponse structure represents the FaxObs_SetJob operation response
func (*SetJobResponse) MarshalNDR ¶
func (*SetJobResponse) UnmarshalNDR ¶
type SetLoggingCategoriesRequest ¶
type SetLoggingCategoriesRequest struct {
// Buffer: A pointer to an array of FAX_LOG_CATEGORY (section 2.2.11) structures. Each
// structure contains the data to modify one logging category. The data includes a friendly
// name of the logging category, a numeric identifier for the category, and the current
// severity-level threshold for the category. For more information, see [MSDN-FSCAR].
Buffer []byte `idl:"name:Buffer;size_is:(BufferSize);pointer:unique" json:"buffer"`
// BufferSize: A DWORD ([MS-DTYP] section 2.2.9) variable that contains the size, in
// bytes, of the data buffer.
BufferSize uint32 `idl:"name:BufferSize" json:"buffer_size"`
// NumberCategories: A DWORD variable that contains the number of FAX_LOG_CATEGORY structures
// that the method passes in the Buffer parameter.
NumberCategories uint32 `idl:"name:NumberCategories" json:"number_categories"`
}
SetLoggingCategoriesRequest structure represents the FaxObs_SetLoggingCategories operation request
func (*SetLoggingCategoriesRequest) MarshalNDR ¶
func (*SetLoggingCategoriesRequest) UnmarshalNDR ¶
type SetLoggingCategoriesResponse ¶
type SetLoggingCategoriesResponse struct {
// Return: The FaxObs_SetLoggingCategories return value.
Return uint32 `idl:"name:Return" json:"return"`
}
SetLoggingCategoriesResponse structure represents the FaxObs_SetLoggingCategories operation response
func (*SetLoggingCategoriesResponse) MarshalNDR ¶
func (*SetLoggingCategoriesResponse) UnmarshalNDR ¶
type SetPortRequest ¶
type SetPortRequest struct {
// FaxPortHandle: An RPC context handle that references a fax port.
FaxPort *fax.Port `idl:"name:FaxPortHandle" json:"fax_port"`
// PortInfo: A pointer to a FAX_PORT_INFO (section 2.2.7) structure. The structure contains
// data to modify the configuration of the specified fax port. The server MUST ignore
// the State field of this structure.
PortInfo *fax.PortInfo `idl:"name:PortInfo" json:"port_info"`
}
SetPortRequest structure represents the FaxObs_SetPort operation request
func (*SetPortRequest) MarshalNDR ¶
func (*SetPortRequest) UnmarshalNDR ¶
type SetPortResponse ¶
type SetPortResponse struct {
// Return: The FaxObs_SetPort return value.
Return uint32 `idl:"name:Return" json:"return"`
}
SetPortResponse structure represents the FaxObs_SetPort operation response
func (*SetPortResponse) MarshalNDR ¶
func (*SetPortResponse) UnmarshalNDR ¶
type SetRoutingInfoRequest ¶
type SetRoutingInfoRequest struct {
// FaxPortHandle: An RPC context handle that references a specified fax port.
FaxPort *fax.Port `idl:"name:FaxPortHandle" json:"fax_port"`
// RoutingGuid: A curly braced GUID string that uniquely identifies the fax routing
// method to set the routing information for. Fax routing methods are defined by a fax
// routing extension, and the method is identified by a GUID. For more information about
// routing methods, see [MSDN-FRM]. The routing methods and their curly braced GUID
// string values, which can be used for this parameter, are discoverable by calling
// FaxObs_EnumRoutingMethods (section 3.1.4.2.18). Included in this list are the default
// routing methods described in section 2.2.87.
RoutingGUID string `idl:"name:RoutingGuid;string;pointer:unique" json:"routing_guid"`
// RoutingInfoBuffer: A pointer to a buffer that contains the fax routing information
// to be set. The format and contents of this buffer depend on the routing method identified
// by the RoutingGuid parameter.
RoutingInfoBuffer []byte `idl:"name:RoutingInfoBuffer;size_is:(RoutingInfoBufferSize);pointer:unique" json:"routing_info_buffer"`
// RoutingInfoBufferSize: The size, in bytes, of the RoutingInfoBuffer buffer.
RoutingInfoBufferSize uint32 `idl:"name:RoutingInfoBufferSize" json:"routing_info_buffer_size"`
}
SetRoutingInfoRequest structure represents the FaxObs_SetRoutingInfo operation request
func (*SetRoutingInfoRequest) MarshalNDR ¶
func (*SetRoutingInfoRequest) UnmarshalNDR ¶
type SetRoutingInfoResponse ¶
type SetRoutingInfoResponse struct {
// Return: The FaxObs_SetRoutingInfo return value.
Return uint32 `idl:"name:Return" json:"return"`
}
SetRoutingInfoResponse structure represents the FaxObs_SetRoutingInfo operation response
func (*SetRoutingInfoResponse) MarshalNDR ¶
func (*SetRoutingInfoResponse) UnmarshalNDR ¶
type SetSecurityDescriptorRequest ¶
type SetSecurityDescriptorRequest struct {
// FaxSecurityDescriptor: A pointer to a buffer containing a FAX_SECURITY_DESCRIPTOR
// to be set.
FaxSecurityDescriptor []byte `idl:"name:FaxSecurityDescriptor;size_is:(BufferSize);pointer:unique" json:"fax_security_descriptor"`
// BufferSize: A DWORD ([MS-DTYP] section 2.2.9) containing the size, in bytes, of the
// data pointed at by the FaxSecurityDescriptor parameter.
BufferSize uint32 `idl:"name:BufferSize" json:"buffer_size"`
}
SetSecurityDescriptorRequest structure represents the FaxObs_SetSecurityDescriptor operation request
func (*SetSecurityDescriptorRequest) MarshalNDR ¶
func (*SetSecurityDescriptorRequest) UnmarshalNDR ¶
type SetSecurityDescriptorResponse ¶
type SetSecurityDescriptorResponse struct {
// Return: The FaxObs_SetSecurityDescriptor return value.
Return uint32 `idl:"name:Return" json:"return"`
}
SetSecurityDescriptorResponse structure represents the FaxObs_SetSecurityDescriptor operation response
func (*SetSecurityDescriptorResponse) MarshalNDR ¶
func (*SetSecurityDescriptorResponse) UnmarshalNDR ¶
type SetTAPILocationsRequest ¶
type SetTAPILocationsRequest struct {
// Buffer: A pointer to a FAX_TAPI_LOCATION_INFO (section 2.2.89) structure containing
// a list of FAX_TAPI_LOCATIONS, each structure describing one location. The current
// location is identified in this list of by the FAX_TAPI_LOCATIONS with the location
// identifier value (contained by the PermanentLocationID member) described by the CurrentLocationID
// member of the FAX_TAPI_LOCATION_INFO.
Buffer []byte `idl:"name:Buffer;size_is:(BufferSize);pointer:unique" json:"buffer"`
// BufferSize: Pointer to a DWORD ([MS-DTYP] section 2.2.9) variable that contains the
// size, in bytes, of the data contained in the buffer.
BufferSize uint32 `idl:"name:BufferSize" json:"buffer_size"`
}
SetTAPILocationsRequest structure represents the FaxObs_SetTapiLocations operation request
func (*SetTAPILocationsRequest) MarshalNDR ¶
func (*SetTAPILocationsRequest) UnmarshalNDR ¶
type SetTAPILocationsResponse ¶
type SetTAPILocationsResponse struct {
// Return: The FaxObs_SetTapiLocations return value.
Return uint32 `idl:"name:Return" json:"return"`
}
SetTAPILocationsResponse structure represents the FaxObs_SetTapiLocations operation response
func (*SetTAPILocationsResponse) MarshalNDR ¶
func (*SetTAPILocationsResponse) UnmarshalNDR ¶
type StartClientServerRequest ¶
type StartClientServerRequest struct {
// MachineName: A pointer to a null-terminated character string containing the name
// of the fax client machine. The machine name MUST be NULL for a local machine and
// a fully qualified domain name (FQDN) for a remote machine.
MachineName string `idl:"name:MachineName;string;pointer:unique" json:"machine_name"`
// ClientName: A pointer to a null-terminated character string containing the friendly
// name of the fax client application. This name MUST be unique for each fax client
// application running on the same fax client machine.
ClientName string `idl:"name:ClientName;string;pointer:unique" json:"client_name"`
// Context: A ULONG64 ([MS-DTYP] section 2.2.54) value that can be passed to FAX_OpenConnection
// as a notification context. This context is equivalent to the subscription context
// used in the Fax Server Interface methods FAX_StartServerNotification (section 3.1.4.1.100),
// FAX_StartServerNotificationEx (section 3.1.4.1.101), and FAX_StartServerNotificationEx2
// (section 3.1.4.1.102), with the difference that the FaxObs Server Interface (section
// 3.1.4.2) does not have a method similar to FAX_EndServerNotification (section 3.1.4.1.17)
// that the client calls to close this context.
Context uint64 `idl:"name:Context" json:"context"`
}
StartClientServerRequest structure represents the FaxObs_StartClientServer operation request
func (*StartClientServerRequest) MarshalNDR ¶
func (*StartClientServerRequest) UnmarshalNDR ¶
type StartClientServerResponse ¶
type StartClientServerResponse struct {
// Return: The FaxObs_StartClientServer return value.
Return uint32 `idl:"name:Return" json:"return"`
}
StartClientServerResponse structure represents the FaxObs_StartClientServer operation response
func (*StartClientServerResponse) MarshalNDR ¶
func (*StartClientServerResponse) UnmarshalNDR ¶
Source Files
Click to show internal directories.
Click to hide internal directories.