docs: documented data to string conversion functions
This commit is contained in:
parent
a835ee6789
commit
3787701642
|
@ -458,3 +458,45 @@ Returns the amount of chars a string has before it's null-terminator.
|
|||
#### `string_compare(a, b)` - function (bool)
|
||||
Returns **true** when the strings **_a_** and **_b_** are equal.
|
||||
Returns **false** if they aren't equal.
|
||||
|
||||
#### `string_unsigned_dec_to_alpha(string, value)` - function (void)
|
||||
Converts the unsigned integer in **_value_** to an alphanumeric string.
|
||||
The representation is decimal.
|
||||
This string will be written into **_string_**.
|
||||
|
||||
#### `string_dec_to_alpha(string, value)` - function (void)
|
||||
Converts the signed integer in **_value_** to an alphanumeric string.
|
||||
If it is negative it will be prefixed with a hyphen.
|
||||
The representation is decimal.
|
||||
This string will be written into **_string_**.
|
||||
|
||||
#### `string_hex_8bit_to_alpha(string, value)` - function (void)
|
||||
Converts the byte in **_value_** to an alphanumeric string.
|
||||
The representation is hexadecimal.
|
||||
This string will be written into **_string_**.
|
||||
|
||||
#### `string_hex_16bit_to_alpha(string, value)` - function (void)
|
||||
Converts the word(16-bits) in **_value_** to an alphanumeric string.
|
||||
The representation is hexadecimal.
|
||||
This string will be written into **_string_**.
|
||||
|
||||
#### `string_hex_32bit_to_alpha(string, value)` - function (void)
|
||||
Converts the dword(32-bits) in **_value_** to an alphanumeric string.
|
||||
The representation is hexadecimal.
|
||||
This string will be written into **_string_**.
|
||||
|
||||
#### `string_hex_64bit_to_alpha(string, value)` - function (void)
|
||||
Converts the qword(64-bits) in **_value_** to an alphanumeric string.
|
||||
The representation is hexadecimal.
|
||||
This string will be written into **_string_**.
|
||||
|
||||
#### `string_bin_to_alpha(string, num_bits, value)` - function (void)
|
||||
Converts the data in **_value_** to an alphanumeric string.
|
||||
The representation is binary.
|
||||
**_num_bits_** specifies how many bits, starting at the least significant bit, will be converted.
|
||||
This string will be written into **_string_**.
|
||||
|
||||
#### `string_bool_to_alpha(string, value`) - function (void)
|
||||
Converts the boolean in **_value_** to an alphanumeric string.
|
||||
The representation is `true` or `false`.
|
||||
This string will be written into **_string_**.
|
Loading…
Reference in New Issue