onesdk_string_t Struct Reference

Represents a reference to string data in a user specified encoding. More...

Public Attributes
void const *	data
	Pointer to the beginning of the string data. May be NULL if byte_length is zero.
onesdk_size_t	byte_length
	The length of the buffer pointed to by data, in bytes.
onesdk_ccsid_t	ccsid
	Specifies the encoding of the string data.

Detailed Description

Represents a reference to string data in a user specified encoding.

For normal (non-null, non-empty) strings, simply set data to point to the string data, byte_length to the length of the string data in bytes and ccsid to the CCSID value for the used encoding.

For an empty string, set byte_length to zero and ccsid to any valid, supported CCSID value (i.e. not ONESDK_CCSID_NULL).

If you set byte_length to zero and ccsid to ONESDK_CCSID_NULL, the SDK will interpret this as a "null string". To use ONESDK_CCSID_NULL together with a non-zero length is an error.

When calling a function that takes a onesdk_string_t pointer argument, you can also pass a NULL pointer to specify a "null string".

---

The documentation for this struct was generated from the following file:

• onesdk/onesdk_string.h