7.3. DF_ASCIIDATA -- ASCII Data Description

• 7.3.1. DF_ASCIIDATA Definition
• 7.3.2. DF_ASCIIDATA Field Descriptions
• 7.3.3. Usage Rules
• Applicability
• Using Escape Sequences from Dialogic ASCII to Fax Command Set
• Maximum Values for Margins
• Page Size of Converted ASCII Document

The DF_ASCIIDATA data structure describes graphical attributes such as margins, font and line spacing to use in converting an ASCII file to a fax image for transmission.

Use of DF_ASCIIDATA is optional. If used, the DF_IOTT data structure must contain a pointer (io_datap) cast as a void * to the location of the specific DF_ASCIIDATA structure. If the pointer is NULL, default ASCII values are used.

7.3.1. DF_ASCIIDATA Definition

The DF_ASCIIDATA structure consists of the following fields.

 struct df_asciidata {  
     ushort pagelength;     /* Page Length */  
     ushort pagepad;        /* Pad blank scan lines to end of page */  
     ushort topmargin;      /* Top Margin */  
     ushort botmargin;      /* Bottom Margin */  
     ushort leftmargin;     /* Left Margin */  
     ushort rightmargin;    /* Right Margin */  
     ushort linespace;      /* Spacing between ASCII lines */  
     ushort font;           /* Font selection */  
     ushort tabstops;       /* Number of tabstops on a line */  
     uchar  units;          /* Units for specifying margins/lengths */  
     uchar  flags;          /* Reserved for future use */  
 };




7.3.2. DF_ASCIIDATA Field Descriptions

For easier reference, the fields in the DF_ASCIIDATA structure are described in alphabetical order in Table 17. DF_ASCIIDATA Fields.

For additional usage information, see Section 7.3.3. Usage Rules on page 106.

Table 17. DF_ASCIIDATA Fields

Field	Description
botmargin	Default: 2 (corresponds to 0.2 inches) Bottom margin for ASCII text in units. See units field (default for units is 1/10 inch units). Valid values are:   between 0 and 52 in 0.1 inch units   between 0 and 132 in mm units   between 0 and 512 in pels (coarse scan lines)
flags	Reserved for future use.
font	Default: DF_FONT_0 The font used in rendering the ASCII document. See Appendix F for ASCII character set supported. Valid values are:
	DF_FONT_0 (default) -- normal 6 lines/inch; prints approximately 10 characters per inch at an approximate 12 point character; 112 characters maximum per line; 16 scan lines of MH data; 20 (horizontal) by 16 (vertical) pixel font in sans serif Helvetica style.   DF_FONT_3 -- compressed 8 lines/inch; prints approximately 17 characters per inch at an approximate 9 point character; 192 characters maximum per line; 12 scan lines of MH data; 12 (horizontal) by 12 (vertical) pixel font in sans serif Helvetica style.
	When using Windows font handles, the font specified in the font field overrides FC_FONT0 set in fx_setparm( ). For more information on Windows font handles, see Section 6.6. Using Windows Font Handles on page 92.
leftmargin	Default: 3 (corresponds to 0.3 inches) Left margin for ASCII text in units. See units field (default for units is 1/10 inch units). Valid values are:   between 0 and 25 in 0.1 inch units   between 0 and 64 in mm units   between 0 and 512 in pels (pixels)
linespace	Default: DF_SINGLESPACE Linespace can be used to set one of the following: The line space between ASCII text. The font height determines the line spacing for each row. OR   The number of lines per inch.
	Valid values for the line space between ASCII text:   DF_SINGLESPACE -- single space between lines (default)   DF_DOUBLESPACE -- 2 spaces between lines   DF_TRIPLESPACE -- 3 spaces between lines   DF_HALFSPACE -- add a half space to single or double space.
linespace (cont.)	Valid values for the number of lines per inch:   DF_8LPI -- 8 lines per inch   DF_6LPI -- 6 lines per inch   DF_4LPI -- 4 lines per inch   DF_2_4LPI -- 2.4 lines per inch If DF_8LPI is specified for font DF_FONT_0, the font is too large to fit within the 8 lpi requirement.
pagelength	Default: 110 (corresponds to 11 inches) Page length for ASCII text in units. See units field (default for units is 1/10 inch units). To allow embedded formfeed characters in the ASCII data to control the paging, set the value to exceed the longest page of ASCII data. Valid values are:   _52 -- in 0.1 inch units   _133 -- in mm   _513 -- in scan lines
pagepad	Default: DF_PAD Pad last page with blank lines (default) or do not pad with blank lines. All pages received are the same length as specified in pagelength. Valid values are:   DF_PAD -- Pad last page with blank lines (default).   DF_NOPAD -- Do not pad with blank lines.
rightmargin	Default: 3 (corresponds to 0.3 inches) Right margin for ASCII text in units. See units field (default for units is 1/10 inch units). Valid values are:   between 0 and 25 in 0.1 inch units   between 0 and 64 in mm units   between 0 and 512 in pels (pixels)
tabstops	Default: 8 The number of tab stops per line equally spaced based on the total page width. Any tab stops set outside right and left margins are not usable. Valid values: _0
topmargin	Default: 2 (corresponds to 0.2 inches) Top margin for ASCII text in units. See units field (default for units is 1/10 inch units). Valid values are:   between 0 and 52 in 0.1 inch units   between 0 and 132 in mm units   between 0 and 512 in pels (coarse scan lines)
units	Default: DF_UNITS_IN10 The decimal values specified in the margin fields (top, bottom, left and right) and the pagelength field of the DF_ASCIIDATA structure are based on the value in this field. For further detail, see Maximum Values for Margins in Section 7.3.3. Usage Rules on page 106. Valid values are:   DF_UNITS_IN10 -- 1/10" units (default) for specifying margins and page length.   DF_UNITS_MM -- Millimeter units for specifying margins and page length.   DF_PELS -- Number of pixels (horizontal) and number of coarse scan lines (vertical) for specifying margins and page length.

7.3.3. Usage Rules

The following rules apply when you use the DF_ASCIIDATA structure.

Applicability

The values specified in the DF_ASCIIDATA structure apply to the DF_IOTT entry it is associated with, unless the values are overridden by escape sequences from a Dialogic ASCII to Fax command set (see Appendix F).

Using Escape Sequences from Dialogic ASCII to Fax Command Set

The ASCII file may contain embedded escape sequences from a Dialogic ASCII to Fax Command Set (see Appendix F). These escape sequences specify graphical attributes within the ASCII file and override the values specified in the DF_ASCIIDATA structure.

Maximum Values for Margins

The units field determines the unit of measurement for the top, bottom, left and right margin fields in the DF_ASCIIDATA structure.

The maximum decimal value that can be specified for the margin fields is listed in Table 18. Maximum Values for Margins for each of the supported units:

Table 18. Maximum Values for Margins

Units	Top	Bottom	Left	Right
DF_UNITS_IN10 (0.1 inch units)	52	52	25	25
DF_UNITS_MM (mm)	132	132	64	64
DF_PELS (coarse scan lines)	512	512	-	-
DF_PELS (pixels)	-	-	512	512

Page Size of Converted ASCII Document

The conversion of the ASCII text to a fax image takes place at the time of transmission. Line wrapping occurs if the line of ASCII text is longer than the negotiated width of the fax data.

The ASCII data is separated into pages based on the following:

• The maximum number of ASCII lines that can fit on a page determined by the page length, margins and font selection.
• The presence of formfeed characters in the ASCII data.

 
The line wrapping and paging is transparent to the application. The page padding option automatically fills in blank lines to the end of the last page (default). See Appendix F for embedded escape sequences that override the defaults.

For more information on specifying fonts for ASCII to fax, see Chapter 6. Specifying Fonts in ASCII to Fax Conversion.

Click here to contact Dialogic Customer Engineering