api_checking
List of: Functions
Subjects: Debugging
Contents: Kernel

Action: Sets the pointer argument checking for an API call to on or off.

Prototype: outcome api_checking (


logical on_off // TRUE for on


);

Includes: #include "kernel/acis.hxx"

#include "kernel/kernapi/api/api.hxx"

#include "kernel/kernapi/api/kernapi.hxx"

#include "baseutil/logical.h"

Description: With argument checking on, pointer arguments to an API are tested to determine whether they are NULL. If they are NULL, a message is printed and the API returns an outcome with a nonzero error code.


Checks are also made on certain distances and angles supplied to APIs. Some APIs make more extensive checks internally, but the effect is the same. When there is an on error a message prints and the API returns an outcome with a nonzero error code.

Library: kernel

Filename: kern/kernel/kernapi/api/kernapi.hxx

Effect: System routine
PDF/KERN/16FNA.PDF
HTM/DATA/KERN/KERN/16FNA/0015.HTM