StringToCharArray
StringToCharArray
Symbol-wise copies a string converted from Unicode to ANSI, to a selected place of array of uchar type. It returns the number of copied elements.
int StringToCharArray(
string text_string, // source string
uchar& array[], // array
int start=0, // starting position in the array
int count=-1, // number of symbols
uint codepage=CP_ACP // code page
);Parameters
- text_string
[in] String to copy.
- array[]
[out] Array of uchar type.
- start=0
[in] Position from which copying starts. Default - 0.
- count=-1
[in] Number of array elements to copy. Defines length of a resulting string. Default value is -1, which means copying up to the array end, or till terminating ‘\0’. Terminating zero will also be copied to the recipient array, in this case the size of a dynamic array can be increased if necessary to the size of the string. If the size of the dynamic array exceeds the length of the string, the size of the array will not be reduced.
- codepage=CP_ACP
[in] The value of the code page. For the most-used code pages provide appropriate constants.
Return Value
Number of copied elements.
Note
StringToCharArray() function includes terminating zero. To exclude it specify the string length explicitely:
//--- example of copying of string str to array[]
StringToCharArray(str,array,0,StringLen(str));