69 lines
2.8 KiB
C
69 lines
2.8 KiB
C
|
/****************************************************************************
|
||
|
|
* libs/libc/stdlib/lib_onexit.c
|
||
|
|
*
|
||
|
|
* Licensed to the Apache Software Foundation (ASF) under one or more
|
||
|
|
* contributor license agreements. See the NOTICE file distributed with
|
||
|
|
* this work for additional information regarding copyright ownership. The
|
||
|
|
* ASF licenses this file to you under the Apache License, Version 2.0 (the
|
||
|
|
* "License"); you may not use this file except in compliance with the
|
||
|
|
* License. You may obtain a copy of the License at
|
||
|
|
*
|
||
|
|
* http://www.apache.org/licenses/LICENSE-2.0
|
||
|
|
*
|
||
|
|
* Unless required by applicable law or agreed to in writing, software
|
||
|
|
* distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
|
||
|
|
* WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
|
||
|
|
* License for the specific language governing permissions and limitations
|
||
|
|
* under the License.
|
||
|
|
*
|
||
|
|
****************************************************************************/
|
||
|
|
|
||
|
|
/****************************************************************************
|
||
|
|
* Included Files
|
||
|
|
****************************************************************************/
|
||
|
|
|
||
|
|
#include <nuttx/config.h>
|
||
|
|
|
||
|
|
#include <nuttx/atexit.h>
|
||
|
|
|
||
|
|
/****************************************************************************
|
||
|
|
* Public Functions
|
||
|
|
****************************************************************************/
|
||
|
|
|
||
|
|
/****************************************************************************
|
||
|
|
* Name: on_exit
|
||
|
|
*
|
||
|
|
* Description:
|
||
|
|
* Registers a function to be called at program exit.
|
||
|
|
* The on_exit() function registers the given function to be called
|
||
|
|
* at normal process termination, whether via exit or via return from
|
||
|
|
* the program's main(). The function is passed the status argument
|
||
|
|
* given to the last call to exit and the arg argument from on_exit().
|
||
|
|
*
|
||
|
|
* NOTE 1: This function comes from SunOS 4, but is also present in
|
||
|
|
* libc4, libc5 and glibc. It no longer occurs in Solaris (SunOS 5).
|
||
|
|
* Avoid this function, and use the standard atexit() instead.
|
||
|
|
*
|
||
|
|
* Limitations in the current implementation:
|
||
|
|
*
|
||
|
|
* 1. Only a single on_exit function can be registered unless
|
||
|
|
* CONFIG_LIBC_MAX_EXITFUNS defines a larger number.
|
||
|
|
* 2. on_exit functions are not inherited when a new task is
|
||
|
|
* created.
|
||
|
|
*
|
||
|
|
* Input Parameters:
|
||
|
|
* func - A pointer to the function to be called when the task exits.
|
||
|
|
* arg - An argument that will be provided to the on_exit() function when
|
||
|
|
* the task exits.
|
||
|
|
*
|
||
|
|
* Returned Value:
|
||
|
|
* Zero on success. Non-zero on failure.
|
||
|
|
*
|
||
|
|
****************************************************************************/
|
||
|
|
|
||
|
|
int on_exit(CODE void (*func)(int, FAR void *), FAR void *arg)
|
||
|
|
{
|
||
|
|
return atexit_register(ATTYPE_ONEXIT, (CODE void (*)(void))func, arg,
|
||
|
|
NULL);
|
||
|
|
}
|