odbx_escape(3)

NAME
odbx_escape - Prepare strings for inclusion in statements

SYNOPSIS
\FC#include <opendbx/api.h>\F[]

\FCint odbx_escape\F[]
\FC(odbx_t* handle, const char* from, unsigned long fromlen, char* to, unsigned long* tolen);\F[]

DESCRIPTION
\FCodbx_escape\F[]() neutralizes potentially dangerous characters of the string so it can be used as part of a statement. For security reasons every user input has to be passed to \FCodbx_escape\F[]() to avoid SQL injection attacks which can have fatal consequences! It's also a good idea to escape strings returned from database fields again if you want to use them in a query because they don't stay escaped once they are returned as part of a record.

Most backends require the buffer to be more than twice as long as the input string. To be precise, the output buffer must be 2 * size of input + 1 bytes long. After successfully escaping the characters in \FCfrom\F[], they are written into the memory provided via \FCto\F[] and the value/result parameter \FCtolen\F[] is updated to the new length of \FCto\F[] in the end.

The first parameter \FChandle\F[] is the connection object created and returned by \FCodbx_init\F[]() which becomes invalid as soon as it was supplied to \FCodbx_finish\F[]().

\FCfrom\F[] has to point to a character string containing the string which should be used as part of a statement. It doesn't have to be zero-terminated because the length of it is also given via \FCfromlen\F[]. The backends may support variable width character sets like UTF-8 but this function doesn't support the wide char type (wchar_t) where each character has a fixed size of two or four bytes.

The value of the parameter \FCfromlen\F[] must be the length in bytes of the string which \FCfrom\F[] is pointing to. This is also true for variable width character sets like UTF-8 but the wide char type (wchar_t) is not supported. The terminating \0 character shouldn't be part of \FCfromlen\F[].

The calling function provides a buffer for storing the escaped string via \FCto\F[]. In general, the length of the buffer should be more than twice as long as the string passed via \FCfrom\F[] to be able to store the escaped string even if every character has to be escaped.

\FCtolen\F[] is a value-result parameter which points to an integer variable in the calling function. It must contain the original length of the buffer given via \FCto\F[] and if escaping the string in \FCfrom\F[] suceeded, \FCodbx_escape\F[]() will store the new length of the escaped string in this variable.

RETURN VALUE
\FCodbx_escape\F[]() returns \FCODBX_ERR_SUCCESS\F[], or an error code whose value is less than zero if one of the operations couldn't be completed successfully. Possible error codes are listed in the error section and they can be feed to \FCodbx_error\F[]() and \FCodbx_error_type\F[]() to get further details.

ERRORS

-\FCODBX_ERR_BACKEND\F[]
    The native database library returned an error because it wasn't able to escape the given string to be suitable for a statement

-\FCODBX_ERR_PARAM\F[]
    One of the supplied parameters is invalid or is NULL and this isn't allowed in the used backend module or in the native database client library

-\FCODBX_ERR_SIZE\F[]
    The length of the escaped string exceeds or is likely to exeed the available buffer (before 1.1.4 the name of the label was \FCODBX_ERR_TOOLONG\F[] but the value is still the same)

SEE ALSO
\FCodbx_error\F[](), \FCodbx_error_type\F[](), \FCodbx_query\F[]()