Help Center
Help CenterFreeBASIC

CUBytefunction

Converts numeric or string expression to an unsigned byte (UByte)

Converting Data Typesfunctiondocumented

Syntax

Declare Function CUByte ( ByVal expression As datatype ) As UByte
Type typename
Declare Operator Cast ( ) As UByte
End Type

Parameters

NameDescription
expressiona numeric, string, or pointer expression to cast to a UByte value
datatypeany numeric, string, or pointer data type
typenamea user defined type

Return value


A UByte value.

Description


The CUByte function rounds off the decimal part and returns a 8-bit UByte value. The function does not check for an overflow, and results are undefined for values which are less than 0 or larger than 255.

The name can be explained as 'Convert to Unsigned Byte'.

If the argument is a string expression, it is converted to numeric by using ValUInt.

Remarks

Usage


result = CUByte( numeric expression )
result = CUByte( string expression )
result = CUByte( user defined type )

Dialect Differences


  • Not available in the -lang qb dialect unless referenced with the alias __Cubyte.

Differences from QB


  • New to FreeBASIC

See also


Example


' Using the CUBYTE function to convert a numeric value



'Create an UNSIGNED BYTE variable

Dim numeric_value As UByte



'Convert a numeric value

numeric_value = CUByte(123.55)



'Print the result, should return 124

Print numeric_value

Sleep


Reference

  • Documented in KeyPgCubyte.html