doccontent Parameter

Stores the result of the last text import operation in the file.

Scope: File

Syntax

query doccontent 
set doccontent {docOK|docUpdateCancelled|docTruncated|docLimitExceeded} 

Options

docOK 
No recorded warnings or errors for updates to this file.
docLimitExceeded 
The text length limit was exceeded in a line. The update to the line has been accepted as is.
docTruncated 
The text length limit was exceeded in a line. The content of the line has been truncated.
docUpdateCancelled 
The text length limit was exceeded in a line. The update to the line has been cancelled.

Description

The doccontent parameter stores the most severe error or warning result of text import operations. It should be set to docOK prior to a file update (such as loading a file), and verified after the operation. If the text length limit is exceeded during an import operation, the edit line is kept or truncated as specified by the limiterror parameter.

The initial default value for this parameter is docOK. The least severe is the warning docLimitExceeded, and the most severe is the error docUpdateCancelled.

Example

To clear the file update indication prior to an import:

set doccontent docOK 

API Return Codes

-2 
The option specified with the parameter was not valid. Check the syntax requirements for the parameter and try the set command again.

textlimit Parameter
limiterror Parameter