NAME

zkStrxfrm - string transformation

SYNOPSIS

#include "zkString.h"

size_t zkStrxfrm(char *s1, const char *s2, size_t n);

DESCRIPTION

The zkStrxfrm() function transforms the string pointed to by s2 and places the resulting string into the array pointed to by s1. The transformation is such that if strcmp() is applied to two transformed strings, it returns a value greater than, equal to or less than 0, corresponding to the result of zkStrcoll() applied to the same two original strings. No more than n bytes are placed into the resulting array pointed to by s1, including the terminating null byte. If n is 0, s1 is permitted to be NULL. If copying takes place between objects that overlap, the behaviour is undefined.

The zkStrxfrm() function will not change the setting of errno if successful.

Because no return value is reserved to indicate an error, an application wishing to check for error situations should set errno to 0, then call zkStrxfrm(), then check errno.

RETURN VALUE

Upon successful completion, zkStrxfrm() returns the length of the transformed string (not including the terminating null byte). If the value returned is n or more, the contents of the array pointed to by s1 are indeterminate.

On error, zkStrxfrm() may set errno but no return value is reserved to indicate an error.

ERRORS

The zkStrxfrm() function may fail if:

[EINVAL]
The string pointed to by the s2 argument contains characters outside the domain of the collating sequence.

APPLICATION USAGE

The transformation function is such that two transformed strings can be ordered by strcmp() as appropriate to collating sequence information in the program's locale (category LC_COLLATE).

The fact that when n is 0, s1 is permitted to be NULL, is useful to determine the size of the s1 array prior to making the transformation.