| Error codes | ||||
| Error codes | ||||
| Assertions | ||||
(C11)(removed in C23) | ||||
| Bounds checking | ||||
set_constraint_handler_s (C11) | ||||
(C11) | ||||
(C11) |
Defined in header <stdlib.h> | ||
constraint_handler_t set_constraint_handler_s( constraint_handler_t handler); | (1) | (since C11) |
typedefvoid(*constraint_handler_t)(constchar*restrict msg, void*restrict ptr, | (2) | (since C11) |
Ifset_constraint_handler_s is never called, the default handler is implementation-defined: it may beabort_handler_s,ignore_handler_s, or some other implementation-defined handler.
As with all bounds-checked functions,set_constraint_handler_s andconstraint_handler_t are only guaranteed to be available if__STDC_LIB_EXT1__ is defined by the implementation and if the user defines__STDC_WANT_LIB_EXT1__ to the integer constant1 before including<stdlib.h>.
Contents |
| handler | - | pointer to function of typeconstraint_handler_t or a null pointer |
| msg | - | pointer to character string that describes the error |
| ptr | - | pointer to an implementation-defined object or a null pointer. Examples of implementation-defined objects are objects that give the name of the function that detected the violation and the line number when the violation was detected |
| error | - | the error about to be returned by the calling function, if it happens to be one of the functions that returnerrno_t |
A pointer to the previously-installed runtime constraints handler. (Note: this pointer is never a null pointer because callingset_constraint_handler_s(NULL) sets up the system default handler).
#define __STDC_WANT_LIB_EXT1__ 1#include <string.h>#include <stdio.h>#include <stdlib.h> int main(void){#ifdef __STDC_LIB_EXT1__char dst[2]; set_constraint_handler_s(ignore_handler_s);int r= strcpy_s(dst,sizeof dst,"Too long!");printf("dst =\"%s\", r = %d\n", dst, r); set_constraint_handler_s(abort_handler_s); r= strcpy_s(dst,sizeof dst,"Too long!");printf("dst =\"%s\", r = %d\n", dst, r);#endif}
Possible output:
dst = "", r = 22abort_handler_s was called in response to a runtime-constraint violation. The runtime-constraint violation was caused by the following expression in strcpy_s:(s1max <= (s2_len=strnlen_s(s2, s1max)) ) (in string_s.c:62) Note to end users: This program was terminated as a resultof a bug present in the software. Please reach out to yoursoftware's vendor to get more help.Aborted
(C11) | abort callback for the bounds-checked functions (function)[edit] |
(C11) | ignore callback for the bounds-checked functions (function)[edit] |