-
Notifications
You must be signed in to change notification settings - Fork 1
/
xfoifc_c.h
3248 lines (2963 loc) · 125 KB
/
xfoifc_c.h
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
/**
* @file xfoifc_c.h
* @brief AH Formatter C Interface
*
* @author Antenna House, Inc.
*
* Copyright (C) 2002-2006 Antenna House, Inc. All rights reserved.
*/
#ifndef XFOIFC_C_H__
#define XFOIFC_C_H__
#include <stddef.h>
#if !defined(_DOXYGEN) && defined(_MSC_VER) && defined(_WIN32)
#ifdef XFOINTERFACE_EXPORTS
#define XFOINTERFACE_API __declspec( dllexport )
#else
#define XFOINTERFACE_API __declspec( dllimport )
#endif
#else
#define XFOINTERFACE_API
#endif
/**
* Error Code
*/
typedef long XfoIfErrorCode; /* 0 means no error */
/**
* Error Level
*/
typedef enum {
ELVL_NORMAL = 0, /* no error */
ELVL_INFORMATION = 1,
ELVL_WARNING = 2,
ELVL_RECOVERABLE = 3,
ELVL_FATAL = 4
} XfoIfErrorLevel;
/**
* Error Stream Type for MessageListener
*/
typedef enum {
EST_NONE, /* no output */
EST_STDOUT, /* output to stdout */
EST_STDERR /* output to stderr */
} XfoErrorStreamType;
/**
* PDF version
*/
typedef enum {
PDF_13, /* PDF 1.3 */
PDF_14, /* PDF 1.4 */
PDF_15, /* PDF 1.5 */
PDF_16, /* PDF 1.6 */
PDF_17, /* PDF 1.7 */
PDFX_1a_2001= 101, /* ISO 15930-1:2001 PDF/X-1a-2001 (based on PDF1.3) */
PDFX_3_2002 = 103, /* ISO 15930-3:2002 PDF/X-3-2002 (based on PDF1.3) */
PDFX_1a_2003= 104, /* ISO 15930-4:2003 PDF/X-1a-2003 (based on PDF1.4) */
PDFX_2_2003 = 105, /* ISO 15930-5:2003 PDF/X-2-2003 (based on PDF1.4) */
PDFX_3_2003 = 106, /* ISO 15930-6:2003 PDF/X-3-2003 (based on PDF1.4) */
PDFA_1a_2005= 200, /* ISO 19005-1:2005 (based on PDF1.4) */
PDFA_1b_2005= 400 /* ISO 19005-1:2005 (based on PDF1.4) */
} XfoPDFVERSION;
/**
* PDF encrypt level
*/
typedef enum {
ENCLEVEL_40RC4 = 0, /* 40-bit RC4 */
ENCLEVEL_128RC4, /* 128-bit RC4 */
ENCLEVEL_128AES, /* 128-bit AES */
ENCLEVEL_256AES, /* 256-bit AES */
ENCLEVEL_40 = ENCLEVEL_40RC4,
ENCLEVEL_128 = ENCLEVEL_128RC4
} XfoPDFENCRYPTLEVEL;
/**
* PDF print allow
*/
typedef enum {
PRALLOW_NONE, /* not allowed */
PRALLOW_LOW, /* low resolution printing */
PRALLOW_HIGH /* high resolution printing */
} XfoPDFPRINTALLOW;
/**
* PDF image compression
*/
typedef enum {
IMGCMPR_AUTO, /* auto */
IMGCMPR_JPEG, /* JPEG */
IMGCMPR_ZLIB, /* ZLIB */
IMGCMPR_JPEG2K /* JPEG2000 */
} XfoPDFIMAGECOMPRESSION;
/**
* PDF RGB conversion
*/
typedef enum {
RGBCONV_NONE, /* no conversion */
RGBCONV_BLACK, /* black to devicegray */
RGBCONV_GRAY, /* gray to devicegray */
RGBCONV_ALL /* all rgb to devicegray */
} XfoPDFRGBCONVERSION;
/**
* Embed font
*/
typedef enum {
EMBALLFONT_PART, /* specified fonts */
EMBALLFONT_ALL, /* all fonts except Base14 fonts */
EMBALLFONT_BASE14 /* all fonts */
} XfoEMBEDALLFONT;
/**
* Image downsampling
*/
typedef enum {
IMGDOWNSAMPLING_NONE, /* no downsampling */
IMGDOWNSAMPLING_AVERAGE, /* average downsampling */
IMGDOWNSAMPLING_BICUBIC, /* bicubic downsampling */
IMGDOWNSAMPLING_SUBSAMPLING /* subsampling */
} XfoIMAGEDOWNSAMPLING;
/**
* Monochrome compression
*/
typedef enum {
MONOCMPR_CCITT4, /* CCITTFaxDecode group 4 filter,default value */
MONOCMPR_CCITT3, /* CCITTFaxDecode group 3 filter */
MONOCMPR_RUNLENGTH, /* RunLengthDecode filter */
MONOCMPR_ZLIB, /* FlateDecode filter */
MONOCMPR_OFF /* no filter */
} XfoMONOCHROMECOMPRESSION;
/**
* SVG version
*/
typedef enum {
SVG_11, /* SVG 1.1 */
SVG_Basic, /* SVG Basic */
SVG_Tiny /* SVG Tiny */
} XfoSVGVERSION;
/**
* Image processing
*/
typedef enum {
IMGPT_EMBED_ALL, /* embed all */
IMGPT_COPY_ALL, /* copy all */
IMGPT_LINK, /* link */
IMGPT_COPY /* copy */
} XfoIMAGEPROCTYPE;
/**
* Image conversion
*/
typedef enum {
IMGCNV_AUTO, /* auto */
IMGCNV_JPEG, /* jpeg conversion except png */
IMGCNV_PNG, /* png conversion except jpeg */
IMGCNV_JPEGALL /* jpeg-all conversion */
} XfoIMAGECONVERSION;
/**
* Formatter type
*/
typedef enum {
FMTTYP_AUTO, /* auto */
FMTTYP_HTML, /* html */
FMTTYP_XHTML, /* xhtml */
FMTTYP_XMLCSS, /* xml+css */
FMTTYP_XSLFO /* xsl-fo */
} XfoFORMATTERTYPE;
/**
* INX output mode
*/
typedef enum {
INXOM_TEXT, /* text area output mode */
INXOM_LINE, /* line area output */
INXOM_BLOCK /* block area output */
} XfoINXOUTPUTMODE;
/**
* MIF output mode
*/
typedef enum {
MIFOM_TEXT, /* text area output mode */
MIFOM_LINE, /* line area output */
MIFOM_BLOCK /* block area output */
} XfoMIFOUTPUTMODE;
/**
* MIF Image processiong mode
*/
typedef enum {
MIFIP_EMBED, /* image embed mode*/
MIFIP_LINK_R, /* link image relative path mode */
MIFIP_LINK_A /* link image absolute path mode */
} XfoMIFIMAGEPROCMODE;
/***************************************************************
* for compatibility -- obsolete types
*/
typedef XfoPDFVERSION PDFVERSION;
typedef XfoPDFENCRYPTLEVEL PDFENCRYPTLEVEL;
typedef XfoPDFPRINTALLOW PDFPRINTALLOW;
typedef XfoPDFIMAGECOMPRESSION PDFIMAGECOMPRESSION;
typedef XfoPDFRGBCONVERSION PDFRGBCONVERSION;
typedef XfoEMBEDALLFONT EMBEDALLFONT;
typedef XfoIMAGEDOWNSAMPLING IMAGEDOWNSAMPLING;
typedef XfoMONOCHROMECOMPRESSION MONOCHROMECOMPRESSION;
typedef XfoSVGVERSION SVGVERSION;
typedef XfoIMAGEPROCTYPE IMAGEPROCTYPE;
typedef XfoIMAGECONVERSION IMAGECONVERSION;
typedef XfoFORMATTERTYPE FORMATTERTYPE;
typedef XfoINXOUTPUTMODE INXOUTPUTMODE;
typedef XfoMIFOUTPUTMODE MIFOUTPUTMODE;
typedef XfoMIFIMAGEPROCMODE MIFIMAGEPROCMODE;
/***************************************************************
* format information
*/
#ifdef __cplusplus
extern "C" {
#endif
/** Pointer to XfoObj instance. */
typedef void* CXfoObjPtr;
/**
* Error callback handler
*/
typedef void (XfoOnMessageProc)(XfoIfErrorLevel errLevel, XfoIfErrorCode errCode, const char* errMessage);
typedef void (XfoOnMessageProcW)(XfoIfErrorLevel errLevel, XfoIfErrorCode errCode, const wchar_t* errMessage);
typedef void (XfoOnFormatPageProc)(long pageNo);
typedef void (XfoOnMessageProcEx)(void* pAnyObj, XfoIfErrorLevel errLevel, XfoIfErrorCode errCode, const char* errMessage);
typedef void (XfoOnMessageProcExW)(void* pAnyObj, XfoIfErrorLevel errLevel, XfoIfErrorCode errCode, const wchar_t* errMessage);
typedef void (XfoOnFormatPageProcEx)(void* pAnyObj, long pageNo);
/**
* Create instance of XfoObj
*
* @return Pointer to XfoObj instance.
*/
XFOINTERFACE_API CXfoObjPtr xfo_createXfoObject();
/**
* Release instance of XfoObj
*
* @param pXfoObj Pointer to XfoObj instance.
*/
XFOINTERFACE_API void xfo_releaseXfoObject(CXfoObjPtr pXfoObj);
/**
* Get formatter type.
* only after Formatter 5.
*
* @param pXfoObj Pointer to XfoObj instance.
* @return type of formatter.
*/
XFOINTERFACE_API XfoFORMATTERTYPE xfo_getFormatterType(CXfoObjPtr pXfoObj);
/**
* Set formatter type.
* only after Formatter 5.
*
* @param pXfoObj Pointer to XfoObj instance.
* @param newVal type of formatter.
*/
XFOINTERFACE_API void xfo_setFormatterType(CXfoObjPtr pXfoObj, XfoFORMATTERTYPE newVal);
/**
* Get the URL of XML document you will format.
*
* @param pXfoObj Pointer to XfoObj instance.
* @param pVal Pointer to the buffer that will receive the text. If the string is as long or longer than the buffer,
* the string is truncated and terminated with a NULL character.
* @param size Specifies the number of the 'pVal' buffer, including the NULL character. If the text exceeds this limit, it is truncated.
* @return Returns the 'pVal'.
*/
XFOINTERFACE_API char* xfo_getDocumentURI(CXfoObjPtr pXfoObj, char* pVal, int size);
/**
* Get the URL of XML document you will format.
*
* @param pXfoObj Pointer to XfoObj instance.
* @param pVal Pointer to the buffer that will receive the text. If the string is as long or longer than the buffer,
* the string is truncated and terminated with a NULL character.
* @param size Specifies the number of the 'pVal' buffer, including the NULL character. If the text exceeds this limit, it is truncated.
* @return Returns the 'pVal'.
*/
XFOINTERFACE_API wchar_t* xfo_getDocumentURIW(CXfoObjPtr pXfoObj, wchar_t* pVal, int size);
/**
* Specifies the URL of XML document you will format.
* If it is omitted or "\@STDIN" is specified, XML document is loaded from stdin.
* The document loaded from stdin are supposed to be FO files.
*
* @param pXfoObj Pointer to XfoObj instance.
* @param newVal Pointer to a null-terminated string to be used as the URL of XSL document.
*/
XFOINTERFACE_API void xfo_setDocumentURI(CXfoObjPtr pXfoObj, const char* newVal);
/**
* Specifies the URL of XML document you will format.
* If it is omitted or "\@STDIN" is specified, XML document is loaded from stdin.
* The document loaded from stdin are supposed to be FO files.
*
* @param pXfoObj Pointer to XfoObj instance.
* @param newVal Pointer to a null-terminated string to be used as the URL of XSL document.
*/
XFOINTERFACE_API void xfo_setDocumentURIW(CXfoObjPtr pXfoObj, const wchar_t* newVal);
/**
* Get the URI of XSL stylesheet for formatting.
*
* @param pXfoObj Pointer to XfoObj instance.
* @param pVal Pointer to the buffer that will receive the text. If the string is as long or longer than the buffer,
* the string is truncated and terminated with a NULL character.
* @param size Specifies the number of the 'pVal' buffer, including the NULL character. If the text exceeds this limit, it is truncated.
* @return Returns the 'pVal'.
*/
XFOINTERFACE_API char* xfo_getStylesheetURI(CXfoObjPtr pXfoObj, char* pVal, int size);
/**
* Get the URI of XSL stylesheet for formatting.
*
* @param pXfoObj Pointer to XfoObj instance.
* @param pVal Pointer to the buffer that will receive the text. If the string is as long or longer than the buffer,
* the string is truncated and terminated with a NULL character.
* @param size Specifies the number of the 'pVal' buffer, including the NULL character. If the text exceeds this limit, it is truncated.
* @return Returns the 'pVal'.
*/
XFOINTERFACE_API wchar_t* xfo_getStylesheetURIW(CXfoObjPtr pXfoObj, wchar_t* pVal, int size);
/**
* Specifies the URI of XSL stylesheet for formatting.
* If the specified XML document is FO, or the XML file contains the processing instruction
* <?xml-stylesheet ...?> and the XSL stylesheet is specified, this setting is ignored.
* Otherwise if there is no setting of this property, an error occurs.
*
* @param pXfoObj Pointer to XfoObj instance.
* @param newVal Pointer to a null-terminated string to be used as the URL of XSL stylesheet.
*/
XFOINTERFACE_API void xfo_setStylesheetURI(CXfoObjPtr pXfoObj, const char* newVal);
/**
* Specifies the URI of XSL stylesheet for formatting.
* If the specified XML document is FO, or the XML file contains the processing instruction
* <?xml-stylesheet ...?> and the XSL stylesheet is specified, this setting is ignored.
* Otherwise if there is no setting of this property, an error occurs.
*
* @param pXfoObj Pointer to XfoObj instance.
* @param newVal Pointer to a null-terminated string to be used as the URL of XSL stylesheet.
*/
XFOINTERFACE_API void xfo_setStylesheetURIW(CXfoObjPtr pXfoObj, const wchar_t* newVal);
/**
* Append the path name of user stylesheet file which describes AH Formatter options.
* @since 5.0
*
* @param pXfoObj Pointer to XfoObj instance.
* @param newVal Pointer to a null-terminated string to be used as the path name of HTML user stylesheet file.
*/
XFOINTERFACE_API void xfo_addUserStylesheetURI(CXfoObjPtr pXfoObj, const char* newVal);
/**
* Append the path name of user stylesheet file which describes AH Formatter options.
* @since 5.0
*
* @param pXfoObj Pointer to XfoObj instance.
* @param newVal Pointer to a null-terminated string to be used as the path name of HTML user stylesheet file.
*/
XFOINTERFACE_API void xfo_addUserStylesheetURIW(CXfoObjPtr pXfoObj, const wchar_t* newVal);
/**
* Get the prior stylesheet title.
*
* @param pXfoObj Pointer to XfoObj instance.
* @param pVal Pointer to the buffer that will receive the text. If the string is as long or longer than the buffer,
* the string is truncated and terminated with a NULL character.
* @param size Specifies the number of the 'pVal' buffer, including the NULL character. If the text exceeds this limit, it is truncated.
* @return Returns the 'pVal'.
*/
XFOINTERFACE_API char* xfo_getStylesheetTitle(CXfoObjPtr pXfoObj, char* pVal, int size);
/**
* Get the prior stylesheet title.
*
* @param pXfoObj Pointer to XfoObj instance.
* @param pVal Pointer to the buffer that will receive the text. If the string is as long or longer than the buffer,
* the string is truncated and terminated with a NULL character.
* @param size Specifies the number of the 'pVal' buffer, including the NULL character. If the text exceeds this limit, it is truncated.
* @return Returns the 'pVal'.
*/
XFOINTERFACE_API wchar_t* xfo_getStylesheetTitleW(CXfoObjPtr pXfoObj, wchar_t* pVal, int size);
/**
* Set the prior stylesheet title.
*
* @param pXfoObj Pointer to XfoObj instance.
* @param newVal Pointer to a null-terminated string to be used as the title of priority stylesheet.
*/
XFOINTERFACE_API void xfo_setStylesheetTitle(CXfoObjPtr pXfoObj, const char* newVal);
/**
* Set the prior stylesheet title.
*
* @param pXfoObj Pointer to XfoObj instance.
* @param newVal Pointer to a null-terminated string to be used as the title of priority stylesheet.
*/
XFOINTERFACE_API void xfo_setStylesheetTitleW(CXfoObjPtr pXfoObj, const wchar_t* newVal);
/**
* Get html default charset.
*
* @param pXfoObj Pointer to XfoObj instance.
* @param pVal Pointer to the buffer that will receive the text. If the string is as long or longer than the buffer,
* the string is truncated and terminated with a NULL character.
* @param size Specifies the number of the 'pVal' buffer, including the NULL character. If the text exceeds this limit, it is truncated.
* @return Returns the 'pVal'.
*/
XFOINTERFACE_API char* xfo_getHtmlDefaultCharset(CXfoObjPtr pXfoObj, char* pVal, int size);
/**
* Get html default charset.
*
* @param pXfoObj Pointer to XfoObj instance.
* @param pVal Pointer to the buffer that will receive the text. If the string is as long or longer than the buffer,
* the string is truncated and terminated with a NULL character.
* @param size Specifies the number of the 'pVal' buffer, including the NULL character. If the text exceeds this limit, it is truncated.
* @return Returns the 'pVal'.
*/
XFOINTERFACE_API wchar_t* xfo_getHtmlDefaultCharsetW(CXfoObjPtr pXfoObj, wchar_t* pVal, int size);
/**
* Set html default charset.
*
* @param pXfoObj Pointer to XfoObj instance.
* @param newVal Pointer to a null-terminated string to be used as the html default charset.
*/
XFOINTERFACE_API void xfo_setHtmlDefaultCharset(CXfoObjPtr pXfoObj, const char* newVal);
/**
* Set html default charset.
*
* @param pXfoObj Pointer to XfoObj instance.
* @param newVal Pointer to a null-terminated string to be used as the html default charset.
*/
XFOINTERFACE_API void xfo_setHtmlDefaultCharsetW(CXfoObjPtr pXfoObj, const wchar_t* newVal);
/**
* Get the path name of the output file.
*
* @param pXfoObj Pointer to XfoObj instance.
* @param pVal Pointer to the buffer that will receive the text. If the string is as long or longer than the buffer,
* the string is truncated and terminated with a NULL character.
* @param size Specifies the number of the 'pVal' buffer, including the NULL character. If the text exceeds this limit, it is truncated.
* @return Returns the 'pVal'.
*/
XFOINTERFACE_API char* xfo_getOutputFilePath(CXfoObjPtr pXfoObj, char* pVal, int size);
/**
* Get the path name of the output file.
*
* @param pXfoObj Pointer to XfoObj instance.
* @param pVal Pointer to the buffer that will receive the text. If the string is as long or longer than the buffer,
* the string is truncated and terminated with a NULL character.
* @param size Specifies the number of the 'pVal' buffer, including the NULL character. If the text exceeds this limit, it is truncated.
* @return Returns the 'pVal'.
*/
XFOINTERFACE_API wchar_t* xfo_getOutputFilePathW(CXfoObjPtr pXfoObj, wchar_t* pVal, int size);
/**
* Specifies the path name of the output file. When "\@STDOUT" is specified, it is considered as stdout.
* If both the printer name and this property are specified, the formatted result will be stored in
* the file by the printer driver.
* When "\@PDF" is specified as output, the PDF is stored in the file specified by this property.
* If the property is not specified, it is considered as stdout.
*
* @param pXfoObj Pointer to XfoObj instance.
* @param newVal Pointer to a null-terminated string to be used as the path name of the output file.
*/
XFOINTERFACE_API void xfo_setOutputFilePath(CXfoObjPtr pXfoObj, const char* newVal);
/**
* Specifies the path name of the output file. When "\@STDOUT" is specified, it is considered as stdout.
* If both the printer name and this property are specified, the formatted result will be stored in
* the file by the printer driver.
* When "\@PDF" is specified as output, the PDF is stored in the file specified by this property.
* If the property is not specified, it is considered as stdout.
*
* @param pXfoObj Pointer to XfoObj instance.
* @param newVal Pointer to a null-terminated string to be used as the path name of the output file.
*/
XFOINTERFACE_API void xfo_setOutputFilePathW(CXfoObjPtr pXfoObj, const wchar_t* newVal);
/**
* Get the path name of XML-format Option setting file which describes AH Formatter options.
*
* @param pXfoObj Pointer to XfoObj instance.
* @param pVal Pointer to the buffer that will receive the text. If the string is as long or longer than the buffer,
* the string is truncated and terminated with a NULL character.
* @param size Specifies the number of the 'pVal' buffer, including the NULL character. If the text exceeds this limit, it is truncated.
* @param n Specifies to get n-th URI. 0 means first URI.
* @return Returns the 'pVal'.
*/
XFOINTERFACE_API char* xfo_getOptionFileURI(CXfoObjPtr pXfoObj, char* pVal, int size, int n);
/**
* Get the path name of XML-format Option setting file which describes AH Formatter options.
*
* @param pXfoObj Pointer to XfoObj instance.
* @param pVal Pointer to the buffer that will receive the text. If the string is as long or longer than the buffer,
* the string is truncated and terminated with a NULL character.
* @param size Specifies the number of the 'pVal' buffer, including the NULL character. If the text exceeds this limit, it is truncated.
* @param n Specifies to get n-th URI. 0 means first URI.
* @return Returns the 'pVal'.
*/
XFOINTERFACE_API wchar_t* xfo_getOptionFileURIW(CXfoObjPtr pXfoObj, wchar_t* pVal, int size, int n);
/**
* Specifies the path name of XML-format Option setting file which describes AH Formatter options.
* The set of former URIs is thrown away.
*
* @param pXfoObj Pointer to XfoObj instance.
* @param newVal Pointer to a null-terminated string to be used as the path name of XML-format Option setting file.
*/
XFOINTERFACE_API void xfo_setOptionFileURI(CXfoObjPtr pXfoObj, const char* newVal);
/**
* Specifies the path name of XML-format Option setting file which describes AH Formatter options.
* The set of former URIs is thrown away.
*
* @param pXfoObj Pointer to XfoObj instance.
* @param newVal Pointer to a null-terminated string to be used as the path name of XML-format Option setting file.
*/
XFOINTERFACE_API void xfo_setOptionFileURIW(CXfoObjPtr pXfoObj, const wchar_t* newVal);
/**
* Append the path name of XML-format Option setting file which describes AH Formatter options.
* @since 3.1
*
* @param pXfoObj Pointer to XfoObj instance.
* @param newVal Pointer to a null-terminated string to be used as the path name of XML-format Option setting file.
*/
XFOINTERFACE_API void xfo_addOptionFileURI(CXfoObjPtr pXfoObj, const char* newVal);
/**
* Append the path name of XML-format Option setting file which describes AH Formatter options.
* @since 3.1
*
* @param pXfoObj Pointer to XfoObj instance.
* @param newVal Pointer to a null-terminated string to be used as the path name of XML-format Option setting file.
*/
XFOINTERFACE_API void xfo_addOptionFileURIW(CXfoObjPtr pXfoObj, const wchar_t* newVal);
/**
* Get the number of URIs of XML-format Option setting file which describes AH Formatter options.
* @since 3.1
*
* @param pXfoObj Pointer to XfoObj instance.
* @return Returns the number of URIs.
*/
XFOINTERFACE_API int xfo_getOptionFileCount(CXfoObjPtr pXfoObj);
/**
* Get the output FO file as the result of XSLT when the input files are an XML document and XSL stylesheet.
*
* @param pXfoObj Pointer to XfoObj instance.
* @param pVal Pointer to the buffer that will receive the text. If the string is as long or longer than the buffer,
* the string is truncated and terminated with a NULL character.
* @param size Specifies the number of the 'pVal' buffer, including the NULL character. If the text exceeds this limit, it is truncated.
* @return Returns the 'pVal'.
*/
XFOINTERFACE_API char* xfo_getOutputFOPath(CXfoObjPtr pXfoObj, char* pVal, int size);
/**
* Get the output FO file as the result of XSLT when the input files are an XML document and XSL stylesheet.
*
* @param pXfoObj Pointer to XfoObj instance.
* @param pVal Pointer to the buffer that will receive the text. If the string is as long or longer than the buffer,
* the string is truncated and terminated with a NULL character.
* @param size Specifies the number of the 'pVal' buffer, including the NULL character. If the text exceeds this limit, it is truncated.
* @return Returns the 'pVal'.
*/
XFOINTERFACE_API wchar_t* xfo_getOutputFOPathW(CXfoObjPtr pXfoObj, wchar_t* pVal, int size);
/**
* Specifies the output FO file as the result of XSLT when the input files are an XML document and XSL stylesheet.
* If the input file is FO, no file is outputted. When "\@STDOUT" is specified, it is considered as stdout.
* If the setting is omitted, nothing outputs.
*
* @param pXfoObj Pointer to XfoObj instance.
* @param newVal Pointer to a null-terminated string to be used as the path name of output FO file.
*/
XFOINTERFACE_API void xfo_setOutputFOPath(CXfoObjPtr pXfoObj, const char* newVal);
/**
* Specifies the output FO file as the result of XSLT when the input files are an XML document and XSL stylesheet.
* If the input file is FO, no file is outputted. When "\@STDOUT" is specified, it is considered as stdout.
* If the setting is omitted, nothing outputs.
*
* @param pXfoObj Pointer to XfoObj instance.
* @param newVal Pointer to a null-terminated string to be used as the path name of output FO file.
*/
XFOINTERFACE_API void xfo_setOutputFOPathW(CXfoObjPtr pXfoObj, const wchar_t* newVal);
/**
* Get the command line of External XSLT Processor.
*
* @param pXfoObj Pointer to XfoObj instance.
* @param pVal Pointer to the buffer that will receive the text. If the string is as long or longer than the buffer,
* the string is truncated and terminated with a NULL character.
* @param size Specifies the number of the 'pVal' buffer, including the NULL character. If the text exceeds this limit, it is truncated.
* @return Returns the 'pVal'.
*/
XFOINTERFACE_API char* xfo_getExternalXSLT(CXfoObjPtr pXfoObj, char* pVal, int size);
/**
* Get the command line of External XSLT Processor.
*
* @param pXfoObj Pointer to XfoObj instance.
* @param pVal Pointer to the buffer that will receive the text. If the string is as long or longer than the buffer,
* the string is truncated and terminated with a NULL character.
* @param size Specifies the number of the 'pVal' buffer, including the NULL character. If the text exceeds this limit, it is truncated.
* @return Returns the 'pVal'.
*/
XFOINTERFACE_API wchar_t* xfo_getExternalXSLTW(CXfoObjPtr pXfoObj, wchar_t* pVal, int size);
/**
* Specifies the command line of External XSLT Processor.
* If this is omitted, default MSXML3 will be used. For example:
* <pre>
* xslt \%param -o \%3 \%1 \%2</pre>
*
* These meanings are as follows.<pre>
* \%1 : XML Document
* \%2 : XSL Stylesheet
* \%3 : XSLT Output File
* \%param : xsl:param</pre>
* \%1 to \%3 are used to express only parameter positions. Do not replace them actual file names.
* In case you use XSL:param for external XSLT processor, set the parameter in XSLTParamFormat and SetXSLTParam.
*
* @param pXfoObj Pointer to XfoObj instance.
* @param newVal Pointer to a null-terminated string to be used as the command line of External XSLT Processor.
*/
XFOINTERFACE_API void xfo_setExternalXSLT(CXfoObjPtr pXfoObj, const char* newVal);
/**
* Specifies the command line of External XSLT Processor.
* If this is omitted, default MSXML3 will be used. For example:
* <pre>
* xslt \%param -o \%3 \%1 \%2</pre>
*
* These meanings are as follows.<pre>
* \%1 : XML Document
* \%2 : XSL Stylesheet
* \%3 : XSLT Output File
* \%param : xsl:param</pre>
* \%1 to \%3 are used to express only parameter positions. Do not replace them actual file names.
* In case you use XSL:param for external XSLT processor, set the parameter in XSLTParamFormat and SetXSLTParam.
*
* @param pXfoObj Pointer to XfoObj instance.
* @param newVal Pointer to a null-terminated string to be used as the command line of External XSLT Processor.
*/
XFOINTERFACE_API void xfo_setExternalXSLTW(CXfoObjPtr pXfoObj, const wchar_t* newVal);
/**
* Get the default base URI.
*
* @param pXfoObj Pointer to XfoObj instance.
* @param pVal Pointer to the buffer that will receive the text. If the string is as long or longer than the buffer,
* the string is truncated and terminated with a NULL character.
* @param size Specifies the number of the 'pVal' buffer, including the NULL character. If the text exceeds this limit, it is truncated.
* @return Returns the 'pVal'.
*/
XFOINTERFACE_API char* xfo_getBaseURI(CXfoObjPtr pXfoObj, char* pVal, int size);
/**
* Get the default base URI.
*
* @param pXfoObj Pointer to XfoObj instance.
* @param pVal Pointer to the buffer that will receive the text. If the string is as long or longer than the buffer,
* the string is truncated and terminated with a NULL character.
* @param size Specifies the number of the 'pVal' buffer, including the NULL character. If the text exceeds this limit, it is truncated.
* @return Returns the 'pVal'.
*/
XFOINTERFACE_API wchar_t* xfo_getBaseURIW(CXfoObjPtr pXfoObj, wchar_t* pVal, int size);
/**
* Specifies the default base URI.
*
* @param pXfoObj Pointer to XfoObj instance.
* @param newVal Pointer to a null-terminated string to be used as the default base URI.
*/
XFOINTERFACE_API void xfo_setBaseURI(CXfoObjPtr pXfoObj, const char* newVal);
/**
* Specifies the default base URI.
*
* @param pXfoObj Pointer to XfoObj instance.
* @param newVal Pointer to a null-terminated string to be used as the default base URI.
*/
XFOINTERFACE_API void xfo_setBaseURIW(CXfoObjPtr pXfoObj, const wchar_t* newVal);
/**
* Get the parameter format of xsl:param when using External XSLT Processor.
*
* @param pXfoObj Pointer to XfoObj instance.
* @param pVal Pointer to the buffer that will receive the text. If the string is as long or longer than the buffer,
* the string is truncated and terminated with a NULL character.
* @param size Specifies the number of the 'pVal' buffer, including the NULL character. If the text exceeds this limit, it is truncated.
* @return Returns the 'pVal'.
*/
XFOINTERFACE_API char* xfo_getXSLTParamFormat(CXfoObjPtr pXfoObj, char* pVal, int size);
/**
* Get the parameter format of xsl:param when using External XSLT Processor.
*
* @param pXfoObj Pointer to XfoObj instance.
* @param pVal Pointer to the buffer that will receive the text. If the string is as long or longer than the buffer,
* the string is truncated and terminated with a NULL character.
* @param size Specifies the number of the 'pVal' buffer, including the NULL character. If the text exceeds this limit, it is truncated.
* @return Returns the 'pVal'.
*/
XFOINTERFACE_API wchar_t* xfo_getXSLTParamFormatW(CXfoObjPtr pXfoObj, wchar_t* pVal, int size);
/**
* Specifies the parameter format of xsl:param when using External XSLT Processor. For example:
* <pre>
* -p \%p \%v</pre>
*
* These meanings are as follows.<pre>
* \%p : Parameter Name
* \%v : Parameter Value</pre>
*
* @param pXfoObj Pointer to XfoObj instance.
* @param newVal Pointer to a null-terminated string to be used as the parameter format of xsl:param when using External XSLT Processor.
*/
XFOINTERFACE_API void xfo_setXSLTParamFormat(CXfoObjPtr pXfoObj, const char* newVal);
/**
* Specifies the parameter format of xsl:param when using External XSLT Processor. For example:
* <pre>
* -p \%p \%v</pre>
*
* These meanings are as follows.<pre>
* \%p : Parameter Name
* \%v : Parameter Value</pre>
*
* @param pXfoObj Pointer to XfoObj instance.
* @param newVal Pointer to a null-terminated string to be used as the parameter format of xsl:param when using External XSLT Processor.
*/
XFOINTERFACE_API void xfo_setXSLTParamFormatW(CXfoObjPtr pXfoObj, const wchar_t* newVal);
/**
* Get the start page number of document to output.
*
* @param pXfoObj Pointer to XfoObj instance.
* @return start page number of output.
*/
XFOINTERFACE_API long xfo_getStartPage(CXfoObjPtr pXfoObj);
/**
* Specifies the start page number of document to output.
* If the start page is omitted or the specified value is 0 or less, the start page is
* considered from the first page.
* If the setting is inconsistent, (for example, StartPage=5 EndPage=3) an error occurs.
*
* @param pXfoObj Pointer to XfoObj instance.
* @param newVal start page number of output.
*/
XFOINTERFACE_API void xfo_setStartPage(CXfoObjPtr pXfoObj, long newVal);
/**
* Get the end page number of document to output.
*
* @param pXfoObj Pointer to XfoObj instance.
* @return end page number of output.
*/
XFOINTERFACE_API long xfo_getEndPage(CXfoObjPtr pXfoObj);
/**
* Specifies the end page number of document to output.
* If the end page is omitted or the specified value exceeds the actual page number, the end page
* is considered as the last page.
* If the setting is inconsistent, (for example, StartPage=5 EndPage=3) an error occurs.
*
* @param pXfoObj Pointer to XfoObj instance.
* @param newVal end page number of output.
*/
XFOINTERFACE_API void xfo_setEndPage(CXfoObjPtr pXfoObj, long newVal);
/**
* @deprecated
* Effective when outputting to PDF.
* Specifies the master password for PDF. The password must be within 32 bytes.
* @since 3.1
*
* @param pXfoObj Pointer to XfoObj instance.
* @param newVal Pointer to a null-terminated string to be used as the master password.
*/
XFOINTERFACE_API void xfo_setPdfMasterPassword(CXfoObjPtr pXfoObj, const char* newVal);
/**
* @deprecated
* Effective when outputting to PDF.
* Specifies the master password for PDF. The password must be within 32 bytes.
* @since 3.1
*
* @param pXfoObj Pointer to XfoObj instance.
* @param newVal Pointer to a null-terminated string to be used as the master password.
*/
XFOINTERFACE_API void xfo_setPdfMasterPasswordW(CXfoObjPtr pXfoObj, const wchar_t* newVal);
/**
* Effective when outputting to PDF.
* Specifies the owner password for PDF. The password must be within 32 bytes.
* @since 3.1
*
* @param pXfoObj Pointer to XfoObj instance.
* @param newVal Pointer to a null-terminated string to be used as the owner password.
*/
XFOINTERFACE_API void xfo_setPdfOwnerPassword(CXfoObjPtr pXfoObj, const char* newVal);
/**
* Effective when outputting to PDF.
* Specifies the owner password for PDF. The password must be within 32 bytes.
* @since 3.1
*
* @param pXfoObj Pointer to XfoObj instance.
* @param newVal Pointer to a null-terminated string to be used as the owner password.
*/
XFOINTERFACE_API void xfo_setPdfOwnerPasswordW(CXfoObjPtr pXfoObj, const wchar_t* newVal);
/**
* Effective when outputting to PDF.
* Specifies the user password for PDF. The password must be within 32 bytes.
* @since 3.1
*
* @param pXfoObj Pointer to XfoObj instance.
* @param newVal Pointer to a null-terminated string to be used as the user password.
*/
XFOINTERFACE_API void xfo_setPdfUserPassword(CXfoObjPtr pXfoObj, const char* newVal);
/**
* Effective when outputting to PDF.
* Specifies the user password for PDF. The password must be within 32 bytes.
* @since 3.1
*
* @param pXfoObj Pointer to XfoObj instance.
* @param newVal Pointer to a null-terminated string to be used as the user password.
*/
XFOINTERFACE_API void xfo_setPdfUserPasswordW(CXfoObjPtr pXfoObj, const wchar_t* newVal);
/**
* Effective when outputting to PDF.
* Disables printing the PDF file.
* @since 3.1
*
* @param pXfoObj Pointer to XfoObj instance.
* @param newVal If nonezero is specified, Disables printing the PDF file.
*/
XFOINTERFACE_API void xfo_setPdfNoPrinting(CXfoObjPtr pXfoObj, long newVal);
/**
* Effective when outputting to PDF.
* Get disables printing the PDF file.
* @since 3.1
*
* @param pXfoObj Pointer to XfoObj instance.
* @return If zero is returned, Enables printing the PDF file.
* If nonezero is returned, Disables printing the PDF file.
*/
XFOINTERFACE_API long xfo_getPdfNoPrinting(CXfoObjPtr pXfoObj);
/**
* Effective when outputting to PDF.
* Disables making changes of the PDF file.
* @since 3.1
*
* @param pXfoObj Pointer to XfoObj instance.
* @param newVal If nonezero is specified, Disables making changes of the PDF file.
*/
XFOINTERFACE_API void xfo_setPdfNoChanging(CXfoObjPtr pXfoObj, long newVal);
/**
* Effective when outputting to PDF.
* Get disables making changes of the PDF file.
* @since 3.1
*
* @param pXfoObj Pointer to XfoObj instance.
* @return If zero is returned, Enables making changes of the PDF file.
* If nonezero is returned, Disables making changes of the PDF file.
*/
XFOINTERFACE_API long xfo_getPdfNoChanging(CXfoObjPtr pXfoObj);
/**
* Effective when outputting to PDF.
* Disables copying the content of the PDF file.
* @since 3.1
*
* @param pXfoObj Pointer to XfoObj instance.
* @param newVal If nonezero is specified, Disables copying the content of the PDF file.
*/
XFOINTERFACE_API void xfo_setPdfNoContentCopying(CXfoObjPtr pXfoObj, long newVal);
/**
* Effective when outputting to PDF.
* Get disables copying the content of the PDF file.
* @since 3.1
*
* @param pXfoObj Pointer to XfoObj instance.
* @return If zero is returned, Enables copying the content of the PDF file.
* If nonezero is returned, Disables copying the content of the PDF file.
*/
XFOINTERFACE_API long xfo_getPdfNoContentCopying(CXfoObjPtr pXfoObj);
/**
* Effective when outputting to PDF.
* Disables adding comments and form fields to the PDF file.
* @since 3.1
*
* @param pXfoObj Pointer to XfoObj instance.
* @param newVal If nonezero is specified, Disables adding comments and form fields to the PDF file.
*/
XFOINTERFACE_API void xfo_setPdfNoAddingOrChangingCommnets(CXfoObjPtr pXfoObj, long newVal);
/**
* Effective when outputting to PDF.
* Get disables adding comments and form fields to the PDF file.
* @since 3.1
*
* @param pXfoObj Pointer to XfoObj instance.
* @return If zero is returned, Enables adding comments and form fields to the PDF file.
* If nonezero is returned, Disables adding comments and form fields to the PDF file.
*/
XFOINTERFACE_API long xfo_getPdfNoAddingOrChangingCommnets(CXfoObjPtr pXfoObj);
/**
* Effective when outputting to PDF.
* Disables adding comments and form fields to the PDF file.
* @since 3.1
*
* @param pXfoObj Pointer to XfoObj instance.
* @param newVal If nonezero is specified, Disables adding comments and form fields to the PDF file.
*/
XFOINTERFACE_API void xfo_setPdfNoAddingOrChangingComments(CXfoObjPtr pXfoObj, long newVal);
/**
* Effective when outputting to PDF.
* Get disables adding comments and form fields to the PDF file.
* @since 3.1
*
* @param pXfoObj Pointer to XfoObj instance.
* @return If zero is returned, Enables adding comments and form fields to the PDF file.
* If nonezero is returned, Disables adding comments and form fields to the PDF file.
*/
XFOINTERFACE_API long xfo_getPdfNoAddingOrChangingComments(CXfoObjPtr pXfoObj);
/**
* Effective when outputting to PDF.
* Enables specifying whether the version of PDF is 1.3, 1.4 or 1.5.
* @since 3.1
*
* @param pXfoObj Pointer to XfoObj instance.
* @param newVal Specifies the version of PDF.
*/
XFOINTERFACE_API void xfo_setPdfVersion(CXfoObjPtr pXfoObj, XfoPDFVERSION newVal);
/**
* Effective when outputting to PDF.
* Get the version of PDF.
* @since 3.1
*
* @param pXfoObj Pointer to XfoObj instance.
* @return the version of PDF.
*/
XFOINTERFACE_API XfoPDFVERSION xfo_getPdfVersion(CXfoObjPtr pXfoObj);
/**
* Effective when outputting to PDF.
* Disables filling in of form fields and signing of the PDF file.
* This parameter is effective only when you specify PDF1.4 or later to PDF version.
* @since 3.1
*
* @param pXfoObj Pointer to XfoObj instance.
* @param newVal If nonezero is specified, Disables filling in of form fields and signing of the PDF file.
*/
XFOINTERFACE_API void xfo_setPdfNoFillForm(CXfoObjPtr pXfoObj, long newVal);
/**
* Effective when outputting to PDF.
* Get disables filling in of form fields and signing of the PDF file.
* @since 3.1
*
* @param pXfoObj Pointer to XfoObj instance.
* @return If zero is returned, Enables filling in of form fields and signing of the PDF file.
* If nonezero is returned, Disables filling in of form fields and signing of the PDF file.
*/
XFOINTERFACE_API long xfo_getPdfNoFillForm(CXfoObjPtr pXfoObj);
/**
* Effective when outputting to PDF.
* Disables text access for screen reader devices of the PDF file.
* This parameter is effective only when you specify 1.4 or later with PDF version.
* @since 3.1
*
* @param pXfoObj Pointer to XfoObj instance.
* @param newVal If nonezero is specified, Disables text access for screen reader devices of the PDF file.
*/
XFOINTERFACE_API void xfo_setPdfNoAccessibility(CXfoObjPtr pXfoObj, long newVal);