File (internal function) - Revision history

Laura at 17:11, 24 September 2014

2014-09-24T17:11:53Z

@@ Line 30: / Line 30: @@
 The above file() reference redimensions num-arrayname to 4 elements and returns X (horizontal), Y (vertical), Width, and Height in pixels of either the window or usable area rectangle.
-====Extended Syntax====
+====Fontsize====
 =====extended syntax examples=====

Laura at 17:09, 24 September 2014

2014-09-24T17:09:09Z

← Older revision		Revision as of 17:09, 24 September 2014
Line 23:		Line 23:

	''Print File(N)'' will return -1 when the file N is not opened. File(N) can be used to separate input from output errors in file processing, including communications files.		''Print File(N)'' will return -1 when the file N is not opened. File(N) can be used to separate input from output errors in file processing, including communications files.

			====Window Interrogation====
			Using file with the optional parameters, [[WINDOW_RECT]] or [[USABLE_RECT]] allows BR to distinguish between window dimensions and the useable area of windows.
			file(nn,"WINDOW_RECT \| USABLE_RECT", MAT num-arrayname)

			The above file() reference redimensions num-arrayname to 4 elements and returns X (horizontal), Y (vertical), Width, and Height in pixels of either the window or usable area rectangle.

	====Extended Syntax====		====Extended Syntax====

Laura at 19:33, 21 May 2014

2014-05-21T19:33:27Z

← Older revision		Revision as of 19:33, 21 May 2014
Line 1:		Line 1:

	File(N)		File(<[[file handle]]>)

	The '''File''' [[internal function]] returns the numeric value that specifies the status of file ~~N, where N is a~~ [[File Handle]].		The '''File''' [[internal function]] returns the numeric value that specifies the status of file associated with the [[File Handle]].

	{\|		{\|

John: moved File (Internal Function) to File (internal function)

2014-02-26T16:15:02Z

moved File (Internal Function) to File (internal function)

← Older revision	Revision as of 16:15, 26 February 2014
(No difference)

John: moved FILE (internal function) to File (Internal Function)

2014-02-24T18:30:32Z

moved FILE (internal function) to File (Internal Function)

← Older revision	Revision as of 18:30, 24 February 2014
(No difference)

John at 18:30, 24 February 2014

2014-02-24T18:30:21Z

← Older revision		Revision as of 18:30, 24 February 2014
Line 2:		Line 2:
	File(N)		File(N)

	The '''File''' internal function returns the numeric value that specifies the status of file N, where N is a [[File Handle]].		The '''File''' [[internal function]] returns the numeric value that specifies the status of file N, where N is a [[File Handle]].

	{\|		{\|

Mikhail.zheleznov: *

2012-01-24T11:23:31Z

← Older revision		Revision as of 11:23, 24 January 2012
Line 55:		Line 55:
	*[[File$]]		*[[File$]]
	*[[FileNum]]		*[[FileNum]]
	*[[~~FreeSP~~]]		*[[FREESP]]
	*[[KLn]]		*[[KLn]]
	*[[KPs]]		*[[KPs]]

Mikhail.zheleznov: *

2012-01-24T11:23:13Z

← Older revision		Revision as of 11:23, 24 January 2012
Line 2:		Line 2:
	File(N)		File(N)

	The '''File''' [[internal function~~]] will return~~ the numeric value that specifies the status of file N. N is a [[File Handle]].		The '''File''' internal function returns the numeric value that specifies the status of file N, where N is a [[File Handle]].

	{\|		{\|
Line 21:		Line 21:

	====Comments and Examples====		====Comments and Examples====

	''Print File(N)'' will return -1 when the file N is not opened. File(N) can be used to separate input from output errors in file processing, including communications files.		''Print File(N)'' will return -1 when the file N is not opened. File(N) can be used to separate input from output errors in file processing, including communications files.


	====Extended Syntax====		====Extended Syntax====

	As of ~~Business Rules!~~ [[4.20]] file's syntax has been expanded to allow the querying of a windows size and shape.		As of BR [[4.20]] file's syntax has been expanded to allow the querying of a windows size and shape.

	file(nn,"WINDOW_RECT \| USABLE_RECT", MAT num-arrayname)		file(N,"WINDOW_RECT \| USABLE_RECT", MAT num-arrayname)

	BR distinguishes between window dimensions and the useable area of windows.		BR distinguishes between window dimensions and the useable area of windows.

	The above file() reference redimensions num-arrayname to 4 elements and returns nX (horizontal), Y (vertical), Width, and Height in pixels of either the window		The above file() reference redimensions num-arrayname to 4 elements and returns X (horizontal), Y (vertical), Width, and Height in pixels of either the window
	or usable area rectangle.		or usable area rectangle.

	file(nn,"FONTSIZE", MAT num-arrayname)		file(N,"FONTSIZE", MAT num-arrayname)

	This FONTSIZE reference returns a two element array with the height and width of each fixed character position in pixels (used for positioning and sizing controls).		This FONTSIZE reference returns a two element array with the height and width of each fixed character position in pixels (used for positioning and sizing controls).
Line 42:		Line 42:

	file(101,'WINDOW_RECT',mat x)		file(101,'WINDOW_RECT',mat x)

	returns 4 items in mat x		returns 4 items in mat x
	*x(1)=left		*x(1)=left

Mikhail.zheleznov: moved File (internal function) to FILE (internal function)

2012-01-17T08:58:33Z

moved File (internal function) to FILE (internal function)

← Older revision	Revision as of 08:58, 17 January 2012
(No difference)

Mikhail.zheleznov: 1 revision

2012-01-15T14:11:52Z

1 revision

New page

File(N)

The '''File''' [[internal function]] will return the numeric value that specifies the status of file N. N is a [[File Handle]].

{|
|-
||-1||File not opened.
|-
||0||Operation performed successfully.
|-
||10||End of file occurred during input.
|-
||11||End of file occurred during output.
|-
||20||Transmission error during input.
|-
||21||Transmission error during output.
|-
|}

====Comments and Examples====
''Print File(N)'' will return -1 when the file N is not opened. File(N) can be used to separate input from output errors in file processing, including communications files.

====Extended Syntax====

As of Business Rules! [[4.20]] file's syntax has been expanded to allow the querying of a windows size and shape.

file(nn,"WINDOW_RECT | USABLE_RECT", MAT num-arrayname)

BR distinguishes between window dimensions and the useable area of windows.

The above file() reference redimensions num-arrayname to 4 elements and returns nX (horizontal), Y (vertical), Width, and Height in pixels of either the window
or usable area rectangle.

file(nn,"FONTSIZE", MAT num-arrayname)

This FONTSIZE reference returns a two element array with the height and width of each fixed character position in pixels (used for positioning and sizing controls).

=====extended syntax examples=====

file(101,'WINDOW_RECT',mat x)
returns 4 items in mat x
*x(1)=left
*x(2)=top
*x(3)=width
*x(4)=height

====See Also====
For additional information about files, see the following:
*[[Exists]]
*[[File$]]
*[[FileNum]]
*[[FreeSP]]
*[[KLn]]
*[[KPs]]
*[[KRec]]
*[[LRec]]
*[[Rec]]
*[[RLn]]
*[[File Handle]]

<noinclude>
[[Category:Internal Functions]]
</noinclude>