from_string
Description:
[ Version ( since = "2.54" ) ]
public static bool from_string (string str, out int64 out_num = null, uint @base = 10, int64 min = MIN, int64 max = MAX) throws NumberParserError
A convenience function for converting a string to a signed number.
This function assumes that str
contains only a number of the given base
that is within inclusive bounds limited by
min
and max
. If this is true, then the converted number is stored in out_num
. An empty string is not a
valid input. A string with leading or trailing whitespace is also an invalid input.
base
can be between 2 and 36 inclusive. Hexadecimal numbers must not be prefixed with "0x" or "0X". Such a problem does not exist
for octal numbers, since they were usually prefixed with a zero which does not change the value of the parsed number.
Parsing failures result in an error with the `G_NUMBER_PARSER_ERROR` domain. If the input is invalid, the error code will be [ error@GLib.NumberParserError.INVALID]. If the parsed number is out of bounds - [error@GLib.NumberParserError.OUT_OF_BOUNDS].
See [func@GLib.ascii_strtoll] if you have more complex needs such as parsing a string which starts with a number, but then has other characters.
Parameters:
str |
a string to convert |
out_num |
a return location for a number |
min |
a lower bound (inclusive) |
max |
an upper bound (inclusive) |
base |
base of a parsed number |
Returns:
true if |