HEIGHT: Difference between revisions

From QB64 Phoenix Edition Wiki
Jump to navigation Jump to search
No edit summary
No edit summary
Line 11: Line 11:
* To get the height of the current program [[SCREEN|screen]] window use zero for the handle value or nothing: {{Parameter|lines&}} = [[_HEIGHT]](0) ''or'' {{Parameter|lines&}} = [[_HEIGHT]]
* To get the height of the current program [[SCREEN|screen]] window use zero for the handle value or nothing: {{Parameter|lines&}} = [[_HEIGHT]](0) ''or'' {{Parameter|lines&}} = [[_HEIGHT]]
* If the image specified by {{Parameter|imageHandle&}} is in text only([[SCREEN]] 0) mode, the number of lines of rows of characters are returned.
* If the image specified by {{Parameter|imageHandle&}} is in text only([[SCREEN]] 0) mode, the number of lines of rows of characters are returned.
* If the image specified by {{Parameter|imageHandle&}} is in graphics mode, the number rows of pixels is returned.  
* If the image specified by {{Parameter|imageHandle&}} is in graphics mode, the number rows of pixels is returned.
* If {{Parameter|imageHandle&}} is an invalid handle, then an [[ERROR Codes|invalid handle error]] is returned.
* If {{Parameter|imageHandle&}} is an invalid handle, then an [[ERROR Codes|invalid handle error]] is returned.
* The last visible pixel coordinate of a program [[SCREEN|screen]] is '''[[_HEIGHT]] - 1'''.
* The last visible pixel coordinate of a program [[SCREEN|screen]] is '''[[_HEIGHT]] - 1'''.

Revision as of 01:46, 23 January 2023

The _HEIGHT function returns the height of an image handle or of the current write page.


Syntax

columns& = _HEIGHT[(imageHandle&)]


Description

  • If imageHandle& is omitted, it's assumed to be the handle of the current SCREEN or write page.
  • To get the height of the current program screen window use zero for the handle value or nothing: lines& = _HEIGHT(0) or lines& = _HEIGHT
  • If the image specified by imageHandle& is in text only(SCREEN 0) mode, the number of lines of rows of characters are returned.
  • If the image specified by imageHandle& is in graphics mode, the number rows of pixels is returned.
  • If imageHandle& is an invalid handle, then an invalid handle error is returned.
  • The last visible pixel coordinate of a program screen is _HEIGHT - 1.


See also



Navigation:
Main Page with Articles and Tutorials
Keyword Reference - Alphabetical
Keyword Reference - By usage
Report a broken link