TXC.DOCFMT'SRC
This field contains flags which adjust the interpretation of the src parameter. Choose no more than one value from each of the first two sections, and zero or more of the ATE Transfer Options, from the following table.
Doc format |
Value |
Description |
|---|---|---|
TXFF_TEXT |
0 |
Standard notepad-style text. CRLF is used to terminate paragraphs, not individual lines. |
TXFF_TEXT_LINES |
1 |
Text with line breaks. This only applies to the output, and if set, inserts line terminators at the points where wrap occurs. |
TXFF_RTF |
2 |
RTF (Rich Text Format) |
TXFF_HTML |
4 |
HTML (browser mode) |
TXFF_UTEXT |
5 |
Unicode text |
TXFF_SSE |
6 |
Proprietary (SSE) format |
Storage medium |
||
TXFF_STRING |
&h0000 |
String variable (aka "buffer," as opposed to "file") |
TXFF_FILE |
&h0100 |
File (versus string/buffer). In the case of TXFF_HTML, this may also be a valid web URL. See Browser Mode. |
ATE Transfer Options |
||
TXFF_RAWBUFF |
&h0400 |
May be set in the TXC.docfmt'src field to cause the source file to be transferred to the ATE client via the ATE auxport transfer protocol, rather than via FTP. (This is the default mode for ATSD, where FTP is typically not available but it may be set explicitly for Unix applications. When TXC.docfmt'src is a buffer (i.e. TXFF_FILE flag is not specified), then TXFF_RAWBUF may be set in the TXC.docfmt'dst field to cause the return buffer to be sent directly (via the stdin channel) rather than via FTP. In both cases, the TXFF_RAWBUF method is faster, provided the amount of text is less than about 4K. (FTP starts out slower due to the need to establish a new connection, but eventually catches up due to windowing and other flow maximization techniques.) Note that the TXFF_RAWBUF bit should only be used in the TXC.docfmt'dst field for files that cannot contain binary data (such as embedded objects). |
TXFF_XFER |
&h0800 |
May be specified in the source format field (TXC.docfmt'src) to force XTEXT to interpret the source file as being local to the server and requiring transfer to the client. Without this flag, the PC filespecs (containing backslashes) will be assumed to be visible directly to the client and thus not requiring file transfer. (This mainly a concern with ATSD where both the server and client environments are Windows.) |
Definition file: ashinc:xtext.def |
||
Comments
TXF_WRAP and TXF_FITVIEW are both typically required for proper display of HTML documents.
