posix_spawnattr_destroy()

Destroy the spawn attributes object

Synopsis:

#include <spawn.h>

int posix_spawnattr_destroy(posix_spawnattr_t *attrp);

Arguments:

attrp: A pointer to the spawn attributes object that you want to destroy.

Library:

libc

Use the -l c option to qcc to link against this library. This library is usually included automatically.

Description:

The posix_spawnattr_destroy() function destroys a spawn attributes object. You can reinitialize a destroyed attrp attributes object by using posix_spawnattr_init() ; the results of referencing the object after you've destroyed it are undefined.

A spawn attributes object is an opaque object of type posix_spawnattr_t (defined in <spawn.h>), and it specifies the inheritance of process attributes across a spawn operation.

The resulting spawn attributes object (possibly modified by setting individual attribute values), is used to modify the behavior of posix_spawn() or posix_spawnp(). After a spawn attributes object has been used to spawn a process by a call to a posix_spawn() or posix_spawnp(), any function affecting the attributes object (including destruction) doesn't affect any process that was spawned in this way.

The posix_spawnattr_destroy() function renders the posix_spawnattr_t unusable. Before you can reuse the object, you must initialize it with posix_spawnattr_init(). POSIX specifies that results are undefined if you use a posix_spawnattr_t object after it has been destroyed, including calling posix_spawnattr_destroy() on an already destroyed object. If you attempt to reference a destroyed attributes object, all of the posix_spawnattr_get*() and posix_spawnattr_set*() operations, as well as posix_spawn(), return EINVAL.

Returns:

EOK: Success.
EINVAL: The value specified by attrp is invalid.

Classification:

POSIX 1003.1 SPN

Safety:
Cancellation point	No
Interrupt handler	Yes
Signal handler	Yes
Thread	Yes