Oct
Converts a number to octal representation
Declare Function Oct Overload ( ByVal number As UByte ) As String
Declare Function Oct ( ByVal number As UShort ) As String
Declare Function Oct ( ByVal number As Ulong ) As String
Declare Function Oct ( ByVal number As ULongInt ) As String
Declare Function Oct ( ByVal number As Const Any Ptr ) As String
Declare Function Oct ( ByVal number As UByte, ByVal digits As Long ) As String
Declare Function Oct ( ByVal number As UShort, ByVal digits As Long ) As String
Declare Function Oct ( ByVal number As Ulong, ByVal digits As Long ) As String
Declare Function Oct ( ByVal number As ULongInt, ByVal digits As Long ) As String
Declare Function Oct ( ByVal number As Const Any Ptr, ByVal digits As Long ) As String
result = Oct[$]( number [, digits ] )
number
A string containing the unsigned octal representation of number.
Returns the unsigned octal string 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)
If you want to do the opposite, i.e. convert an octal string back into a number, the easiest way to do it is to prepend the string with "&O", and convert it using ValInt or ValLng, similarly to a normal numeric string. E.g. ValInt("&O77")
will produce the output:
Syntax
Declare Function Oct Overload ( ByVal number As UByte ) As String
Declare Function Oct ( ByVal number As UShort ) As String
Declare Function Oct ( ByVal number As Ulong ) As String
Declare Function Oct ( ByVal number As ULongInt ) As String
Declare Function Oct ( ByVal number As Const Any Ptr ) As String
Declare Function Oct ( ByVal number As UByte, ByVal digits As Long ) As String
Declare Function Oct ( ByVal number As UShort, ByVal digits As Long ) As String
Declare Function Oct ( ByVal number As Ulong, ByVal digits As Long ) As String
Declare Function Oct ( ByVal number As ULongInt, ByVal digits As Long ) As String
Declare Function Oct ( ByVal number As Const Any Ptr, ByVal digits As Long ) As String
Usage
result = Oct[$]( number [, digits ] )
Parameters
number
A number or expression evaluating to a number. A floating-point number will be converted to a LongInt.
digitsDesired number of digits in the returned string.
Return Value
A string containing the unsigned octal representation of number.
Description
Returns the unsigned octal string 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)
If you want to do the opposite, i.e. convert an octal string back into a number, the easiest way to do it is to prepend the string with "&O", and convert it using ValInt or ValLng, similarly to a normal numeric string. E.g. ValInt("&O77")
Example
Print Oct(54321)
Print Oct(54321, 4)
Print Oct(54321, 8)
Print Oct(54321, 4)
Print Oct(54321, 8)
will produce the output:
152061 2061 00152061
Dialect Differences
- The string type suffix "$" is obligatory in the -lang qb dialect.
- The string type suffix "$" is optional in the -lang fblite and -lang fb dialects.
Differences from QB
- In QBASIC, there was no way to specify the number of digits returned.
- The size of the string returned was limited to 32 bits, or 11 octal digits.
See also