next up previous 264
Next: StcsProps - Return all properties when reading an STC-S document?
Up: AST Attribute Descriptions
Previous: StcsCoords - Return the Coordinates component when reading an STC-S document?


StcsLength - Controls output line length

Description:
This attribute specifies the maximum length to use when writing out text through the sink function supplied when the StcsChan was created. It is ignored if the Indent attribute is zero (in which case the text supplied to the sink function can be of any length). The default value is 70.

The number of characters in each string written out through the sink function will not usually be greater than the value of this attribute (but may be less). However, if any single word in the STC-S description exceeds the specified length, then the word will be written out as a single line.

Note, the default value of zero is unlikely to be appropriate when an StcsChan is used within Fortran code. In this case, StcsLength should usually be set to the size of the CHARACTER variable used to receive the text returned by AST_GETLINE within the sink function. In addition, the Indent attribute should be set non-zero. This avoids the possibility of long lines being truncated invisibly within AST_GETLINE.

Type:
Integer.
Class Applicability:
StcsChan
All StcsChans have this attribute.


next up previous 264
Next: StcsProps - Return all properties when reading an STC-S document?
Up: AST Attribute Descriptions
Previous: StcsCoords - Return the Coordinates component when reading an STC-S document?

AST A Library for Handling World Coordinate Systems in Astronomy
Starlink User Note 210
R.F. Warren-Smith & D.S. Berry
24th May 2011
E-mail:ussc@star.rl.ac.uk

Copyright (C) 2009 Science \& Technology Facilities Council