MidB
From Xojo Documentation
This item was deprecated in version 2019r2. Please use String.MiddleBytes as a replacement. |
Returns a portion of a string. The first character is numbered 1.
Syntax
result=MidB(source, start [,length])
OR
result=stringVariable.MidB(start [,length])
Part | Type | Description |
---|---|---|
result | String | The portion of source from start and continuing for length characters or all remaining characters if length is not specified. The encoding of result is the same as the source. |
source | String | Required. The string from which bytes are returned. |
start | Integer | Required. The position of the first byte to be returned.
If start is greater than the number of bytes in source, an empty string is returned. |
length | Integer | Optional. The number of bytes to return from source.
If omitted, all bytes from start to the end of source are returned. If length + start is greater than the length of source, all bytes from start to the end of source will be returned. |
stringVariable | String | Any variable of type String. |
Notes
MidB treats source as a series of bytes, rather than a series of characters. MidB should be used when source represents binary data. The encoding of the result is the same as the encoding of the source string.
If you need to extract characters rather than bytes, use the Mid function. To determine the number of bytes in a string, use the LenB function.
Examples
These examples use the MidB function to return portions of a string.
s = MidB("This is a test", 6) // returns "is a test"
s = MidB("This is a test", 11, 4) // returns "test"
s = "This is a test"
s = s.MidB(11, 4) // returns "test"