STRING

The String module. More...

Collaboration diagram for STRING:

Macros
#define	OSAPI_STRING_NULL_POINTER   (( t_string *) 0)
	Define a null OSAPI string.
#define	OSAPI_WIDE_STRING_NULL_POINTER   (( t_wString *) 0)
	Define a null OSAPI wide string.
#define	OSAPI_WIDE_CHAR_NULL_POINTER   (( wchar_t *) 0)
	Define a null pointer for an array of wide characters.

Typedefs
typedef struct osapi_basic_string	t_string
	The OSAPI C String type.
typedef struct osapi_wide_string	t_wString
	The OSAPI C String type for wide characters.

Functions
t_status	string_module_supported (void)
	Is the string module supported in the platform. More...
t_status	string_basic_new (t_size size, t_string *string)
	Create a new OSAPI string. More...
t_status	string_basic_create (const char *cstring, t_string *string)
	Create a new OSAPI string based on a C string. More...
t_status	string_basic_delete (t_string *string)
	Delete an OSAPI string. More...
t_status	string_basic_put (const char *cstring, t_string *string)
	Set the OSAPI string with the contents of C string. More...
t_status	string_basic_copy (const char *cstring, t_string *string)
	Copy from a C string into an OSAPI string. More...
t_status	string_basic_size (t_string *string, t_size *size)
	Get the size of the OSAPI string. More...
t_status	string_basic_clone (t_string *string1, t_string *string2)
	Clone an OSAPI string. More...
t_status	string_basic_print (t_string *string)
	Print to standard output the contents of the OSAPI string. More...
t_status	string_basic_get (t_string *string, t_size size, char *cstring)
	Get a C string from an OSAPI string. More...
t_status	string_basic_equal (t_string *string1, t_string *string2, bool *result)
	Check if two OSAPI strings are the same. More...
t_status	string_basic_compare (t_string *string1, t_string *string2, Byte *result)
	Case compare two OSAPI strings. More...
t_status	string_basic_compareIcase (t_string *string1, t_string *string2, Byte *result)
	Case insensitive comparison of two OSAPI strings. More...
t_status	string_basic_concat (t_string *string1, t_string *string2, t_string *string3)
	Concatenation of two OSAPI strings. More...

Detailed Description

The String module.

---

Function Documentation

string_basic_clone()

t_status string_basic_clone	(	t_string *	string1,
		t_string *	string2
	)

Clone an OSAPI string.

Parameters

[in]	string1	- Source string
[out]	string2	- Resulting string

Returns

Operation status

Here is the call graph for this function:

string_basic_compare()

t_status string_basic_compare	(	t_string *	string1,
		t_string *	string2,
		Byte *	result
	)

Case compare two OSAPI strings.

Parameters

[in]	string1	- First string
[in]	string2	- Second string
[out]	result	- True if the strings are identical. False otherwise.

Returns

Operation status

string_basic_compareIcase()

t_status string_basic_compareIcase	(	t_string *	string1,
		t_string *	string2,
		Byte *	result
	)

Case insensitive comparison of two OSAPI strings.

Parameters

[in]	string1	- First string
[in]	string2	- Second string
[out]	result	- True if the strings are identical. False otherwise.

Returns

Operation status

string_basic_concat()

t_status string_basic_concat	(	t_string *	string1,
		t_string *	string2,
		t_string *	string3
	)

Concatenation of two OSAPI strings.

Parameters

[in]	string1	- First string
[in]	string2	- Second string
[out]	string3	- Concatenated string

Returns

Operation status

Here is the call graph for this function:

string_basic_copy()

t_status string_basic_copy	(	const char *	cstring,
		t_string *	string
	)

Copy from a C string into an OSAPI string.

Parameters

[in]	cstring	- The source C string
[out]	string	- The resulting OSAPI string

Returns

Operation status

string_basic_create()

t_status string_basic_create	(	const char *	cstring,
		t_string *	string
	)

Create a new OSAPI string based on a C string.

Parameters

[in]	cstring	- The C string
[out]	string	- The resulting OSAPI string

Returns

Operation status

Here is the call graph for this function:

Here is the caller graph for this function:

string_basic_delete()

t_status string_basic_delete

(

t_string *

string

)

Delete an OSAPI string.

Parameters

[in]

string

- The string to delete

Returns

Operation status

Here is the caller graph for this function:

string_basic_equal()

t_status string_basic_equal	(	t_string *	string1,
		t_string *	string2,
		bool *	result
	)

Check if two OSAPI strings are the same.

Parameters

[in]	string1	- First string
[in]	string2	- Second string
[out]	result	- True if the strings are equal. False otherwise.

Returns

Operation status

string_basic_get()

t_status string_basic_get	(	t_string *	string,
		t_size	size,
		char *	cstring
	)

Get a C string from an OSAPI string.

Parameters

[in]	string	- OSAPI string
[in]	size	- Size of the C string
[out]	cstring	- Resulting C string

Returns

Operation status

string_basic_new()

t_status string_basic_new	(	t_size	size,
		t_string *	string
	)

Create a new OSAPI string.

Parameters

[in]	size	- The memory allocate to the new string
[out]	string	- Address of the new string

Returns

Operation status

string_basic_print()

t_status string_basic_print

(

t_string *

string

)

Print to standard output the contents of the OSAPI string.

Parameters

[in]

string

- OSAPI string

Returns

Operation status

string_basic_put()

t_status string_basic_put	(	const char *	cstring,
		t_string *	string
	)

Set the OSAPI string with the contents of C string.

Parameters

[in]	cstring	- The source C string
[out]	string	- The resulting OSAPI string

Returns

Operation status

string_basic_size()

t_status string_basic_size	(	t_string *	string,
		t_size *	size
	)

Get the size of the OSAPI string.

Parameters

[in]	string	- The OSAPI string
[out]	size	- The size of the OSAPI string

Returns

Operation status

string_module_supported()

t_status string_module_supported

(

void

)

Is the string module supported in the platform.

Returns

Operation status