ToString() datatype

All of the ToString() functions take an input data value and convert it to a string. The string is stored in a user-supplied data buffer with a specified max size. All data types except C8Bool require a conversion format.

To use the Sybase CEP default format, pass NULL as the format argument. You are responsible for supplying the buffer to save the output.

If conversion is successful, the function returns C8_TRUE. If conversion is unsuccessful, then the function returns C8_FALSE; the content of the output buffer is undefined; and the Sybase CEP Engine log will contain an error message. If the output buffer is too short, the output string is silently truncated and C8_FALSE is returned.

C8Bool C8ConvertIntToString(C8Int i_value, const C8Char *format, C8Char *o_buf, C8SizeType o_buf_size); – Purpose: This function converts an integer to a string. The format defaults to "%d", the standard C-language format specifier for integer. You may provide any C-style integer format.
Parameters:
- i_value: The value to convert to a string.
- format: A format specifier indicating the desired format of the resulting string value.
- o_buf: The location into which to store the string. The user must have allocated enough memory to hold the desired string beforehand.
- o_buf_size: The length of the buffer.
Returns: C8_TRUE on success, C8_FALSE otherwise.
C8Bool C8ConvertLongToString(C8Long i_value, const C8Char *format, C8Char *o_buf, C8SizeType o_buf_size); – Purpose: This function converts a long to a string. The format defaults to "%lld". Users may provide any C-style long format.
Parameters:
- i_value: The value to convert.
- format: The format specifier indicating the desired format of the resulting string value.
- o_buf: The location in which to store the string. Allocate the required memory to hold the desired string beforehand.
- o_buf_size: The length of the buffer.
Returns: C8_TRUE on success, C8_FALSE otherwise.
C8Bool C8ConvertBoolToString(C8Bool i_value, C8Char *o_buf, C8SizeType o_buf_size); – Purpose: This function converts a boolean to a string. The result will be the string "true" or "false". If i_value is non-zero, the result will be "true". If i_value is zero, then the output will be "false".
Parameters:
- i_value: The value to convert.
- o_buf: The location in which to store the string. Allocate the required memory to hold the desired string beforehand.
- o_buf_size: The length of the buffer.
Returns: C8_TRUE on success, C8_FALSE otherwise.
C8Bool C8ConvertTimestampToString(C8Timestamp i_value, const C8Char *i_format, C8Char *o_buf, C8SizeType o_buf_size); – Purpose: This function converts a timestamp to a string. If the i_format parameter is invalid, the conversion may fail.
Parameters:
- i_value: The value to convert.
- i_format : A format specifier indicating the desired format of the resulting string value, for example, "YYYY-MM-DD HH24:MI:SS.FF". If the format parameter is a null pointer, the output is in microseconds. To specify another format, please refer to the Sybase CEP CCL Reference Guide 's description of valid formats for TIMESTAMP data type. If the time zone is not specified, the format will default to using local time.
- o_buf: The location in which to store the string. Allocate the required memory to hold the desired string beforehand.
- o_buf_size: The length of the buffer.
Returns: C8_TRUE on success, C8_FALSE otherwise.
C8Bool C8ConvertTimestampTimezoneToString(C8Timestamp i_value, const C8Char *i_format, const C8Char *i_timezone, C8Char *o_buf, C8SizeType o_buf_size); – Purpose: This function converts an internal timestamp to a string while applying appropriate timezone offsets. Conversion may fail if the format or timezone is invalid. Please refer to the time formatting specifications for supported formats. The timezone abbreviations are defined in the c8_timezones.csv file in the plugins directory. See the discussion of time zones and the c8_timezones.csv file in the Sybase CEP CCL Reference Guide for more details.
Parameters:
- i_value: The value to convert.
- i_format: A format specifier indicating the desired format of the resulting string value, for example, "YYYY-MM-DD HH24:MI:SS.FF". If the format parameter is a null pointer, then the output is in microseconds.
- i_timezone: The timezone abbreviation, for example, "PST" for Pacific Standard Time.
- o_buf: The location in which to store the string. Allocate the required memory to hold the desired string beforehand.
- o_buf_siz: The length of the buffer.
Returns: C8_TRUE on success, C8_FALSE otherwise.
C8Bool C8ConvertIntervalToString(C8Interval i_value, const C8Char* i_format, C8Char *o_buf, C8SizeType o_buf_size); – Purpose: This function converts an interval to a string. The parameter i_format is usually NULL, in which case the output interval in o_buf will be in the standard Sybase CEP interval form, similar to +1 23:45:67.123456 (days, hours, minutes, seconds, and fractions of a second). For alternative formats, see the NSPR prprf.h file, which lists the formats accepted by the underlying PR_snprintf code.
Parameters:
- i_value: The value to convert.
- i_format: A format specifier indicating the desired format of the resulting string value.
- o_buf: The location in which to store the string. Allocate the required memory to hold the desired string beforehand.
- o_buf_size: The length of the buffer.
Returns: C8_TRUE on success, C8_FALSE otherwise.
C8Bool C8ConvertFloatToString(C8Float i_value, const C8Char *i_format, C8Char *o_buf, C8SizeType o_buf_size); – Purpose: This function converts a float to a string. The format uses the default of "%lg". Users may provide any C style format that is valid for the C "double" data type (64-bit floating point value), which corresponds to the CCL FLOAT type.
Parameters:
- i_value: The value to convert.
- i_format: A format specifier indicating the desired format of the resulting string value.
- o_buf: The location in which to store the string. Allocate the required memory to hold the desired string beforehand.
- o_buf_siz: The length of the buffer.
Returns: C8_TRUE on success, C8_FALSE otherwise.
C8Bool C8ConvertBlobToHexString(const C8Blob * i_val, C8UInt i_blob_size, C8Char * o_buf, C8SizeType i_buf_size); – Purpose: This function converts a raw BLOB to a string of hexadecimal digits. The caller must provide a buffer for the string large enough to contain the converted string (including the terminating null). Since each byte of the blob will take two characters (hex digits), the size of the buffer must be 2 * i_blob_size + 1.
Note that since strings are limited to 2^32 bytes on many platforms, the longest Blob you can convert to a hex string on those platforms is 2^31 - 1 bytes. Blobs that are 2GB or longer cannot be converted.

C8SizeType is typedef'd in c8types.h.

Parameters:
- i_value: The value to convert.
- i_blob_size: The number of bytes in the raw BLOB.
- o_buf: The location in which to store the string. Allocate the required memory to hold the desired string beforehand.
- i_buf_size: The length of the buffer.
Returns: C8_TRUE on success, C8_FALSE otherwise.