MySQL 8.4.1
Source Code Documentation
mysql_stored_program_runtime_argument_string_imp Class Reference

#include <mysql_stored_program_imp.h>

Static Public Member Functions

static mysql_service_status_t get (stored_program_runtime_context sp_runtime_context, uint16_t index, char const **buffer, size_t *out_len, bool *is_null) noexcept
 Get value of a string argument. More...
 
static mysql_service_status_t set (stored_program_runtime_context sp_runtime_context, uint16_t index, char const *string, size_t length) noexcept
 Set value of a string argument. More...
 

Member Function Documentation

◆ get()

mysql_service_status_t mysql_stored_program_runtime_argument_string_imp::get ( stored_program_runtime_context  sp_runtime_context,
uint16_t  index,
char const **  value,
size_t *  length,
bool *  is_null 
)
staticnoexcept

Get value of a string argument.

Note
: A pointer to the original data is returned. No guarantee is provided that the original data will not be consecutively modified. If the data is to be stored, it needs to be copied locally.
Parameters
[in]sp_runtime_contextstored program runtime context. If null, current runtime context will be used.
[in]indexArgument location
[out]valueA pointer to the original string
[out]lengthLength of the original string
[out]is_nullFlag to indicate if value is null
Returns
Status of operation
Return values
MYSQL_SUCCESSSuccess
MYSQL_FAILUREFailure

◆ set()

mysql_service_status_t mysql_stored_program_runtime_argument_string_imp::set ( stored_program_runtime_context  sp_runtime_context,
uint16_t  index,
char const *  string,
size_t  length 
)
staticnoexcept

Set value of a string argument.

Parameters
[in]sp_runtime_contextstored program runtime context. If null, current runtime context will be used.
[in]indexArgument location
[in]stringValue of the argument
[in]lengthLength of the string
Returns
Status of operation
Return values
MYSQL_SUCCESSSuccess
MYSQL_FAILUREFailure

The documentation for this class was generated from the following files: