Text Model Template: _getData

Text Model Template: _getData

Returns one line of text and its display attributes from the model

Syntax
Details

Syntax

CALL SEND (model-id, '_getData', buffer, attr, maxlen, row, col, ccntrl, return-code<, text-list<, attr-list>>);

Argument Type Description

buffer
C returns the text of the line; buffer can hold up to 200 characters

attr
C returns the attributes of the returned text

maxlen
N returns total length of the text string

row
N specifies which row in the model to read

col
N specifies which column in the model to read

ccntrl
C returns a carriage control character

return-code
N 0 no errors

-1 end of model

-2 other error

text-list
N returns the identifier of an SCL list containing the returned text in excess of 200 characters

attr-list
N returns the identifier of an SCL list containing the attributes of the returned text in excess of 200 characters

Argument	Type	Description
buffer	C	returns the text of the line; buffer can hold up to 200 characters
attr	C	returns the attributes of the returned text
maxlen	N	returns total length of the text string
row	N	specifies which row in the model to read
col	N	specifies which column in the model to read
ccntrl	C	returns a carriage control character
return-code	N	0	no errors
		-1	end of model
		-2	other error
text-list	N	returns the identifier of an SCL list containing the returned text in excess of 200 characters
attr-list	N	returns the identifier of an SCL list containing the attributes of the returned text in excess of 200 characters

Details

The _getData method is called from the text viewer when the viewer needs a row of text from the model. The method is responsible for getting the data to display back to the viewer on a line-by-line basis.

The text-list and attr-list arguments enable their connected viewers to display lines greater than 200 characters. If a line of text is more than 200 characters, buffer contains the first 200 characters and text-list contains the remaining characters. Each string of up to 200 characters is an item in the list. For example, if the line of text is 650 characters long, the first 200 characters of that line are returned in the buffer. Characters 201-400 are in the first item in the list; characters 401-600 are in the second item in the list; characters 601-650 are in the third item in the list. The attr and attr-list arguments are set in the same way.

Chapter Contents
Previous
Next
Top of Page