Help Center
Help CenterFreeBASIC

WOctfunction

Converts a number to a Unicode octal representation

String Functionsfunctiondocumented

Syntax

Declare Function WOct ( ByVal number As UByte ) As WString
Declare Function WOct ( ByVal number As UShort ) As WString
Declare Function WOct ( ByVal number As ULong ) As WString
Declare Function WOct ( ByVal number As ULongInt ) As WString
Declare Function WOct ( ByVal number As Const Any Ptr ) As WString
Declare Function WOct ( ByVal number As UByte, ByVal digits As Long ) As WString
Declare Function WOct ( ByVal number As UShort, ByVal digits As Long ) As WString
Declare Function WOct ( ByVal number As ULong, ByVal digits As Long ) As WString

Parameters

NameDescription
numberNumber to convert to octal representation.
digitsDesired number of digits in the returned string.

Return value


The Unicode octal representation of the number, truncated or padded with zeros ("0") to fit the number of digits, if specified.

Description


Returns the octal WString (Unicode) representation of number. Octal digits range from 0 to 7.

If you specify digits > 0, the result string will be exactly that length. It will be truncated or padded with zeros on the left, if necessary.

The length of the returned string will not be longer than the maximum number of digits required for the type of number (3 characters for Byte, 6 for Short, 11 for Long, and 22 for LongInt)

Remarks

Usage


result = WOct( number [, digits ] )

Dialect Differences


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

Platform Differences


  • Unicode strings are not supported in the DOS port of FreeBASIC.

Differences from QB


  • In QBASIC Unicode was not supported.

See also


Example


Print WOct(54321)

Print WOct(54321, 4)

Print WOct(54321, 8)


will produce the output:

152061
2061
00152061


Reference

  • Documented in KeyPgWoct.html