-
Notifications
You must be signed in to change notification settings - Fork 2
/
server.go
1310 lines (1268 loc) · 94.9 KB
/
server.go
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
package faxobs
import (
"context"
"fmt"
"strings"
"unicode/utf16"
dcerpc "github.com/oiweiwei/go-msrpc/dcerpc"
errors "github.com/oiweiwei/go-msrpc/dcerpc/errors"
uuid "github.com/oiweiwei/go-msrpc/midl/uuid"
ndr "github.com/oiweiwei/go-msrpc/ndr"
)
var (
_ = context.Background
_ = fmt.Errorf
_ = utf16.Encode
_ = strings.TrimPrefix
_ = ndr.ZeroString
_ = (*uuid.UUID)(nil)
_ = (*dcerpc.SyntaxID)(nil)
_ = (*errors.Error)(nil)
)
// faxobs server interface.
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)
// Opnum30NotUsedOnWire operation.
// Opnum30NotUsedOnWire
// 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 |