pthread_attr_getguardsize_np

Obtains the guardsize attribute of the specified thread attributes object.

Syntax

pthread_attr_getguardsize_np( attr );

Argument Data Type Access

attr opaque pthread_attr_t read

C Binding

unsigned long
pthread_attr_getguardsize_np (
pthread_attr_t attr);

Arguments

attr: Thread attributes object whose guardsize attribute is obtained.

Description

This routine obtains the minimum size (in bytes) of the guard area for the stack of a thread that is created using the attributes object specified by the attr argument.

A guard area helps to detect stack overflows by preventing memory access beyond the thread's stack. Large guard areas are necessary when threads might allocate large structures on the stack.

Return Values

On successful completion, this routine returns the guardsize attribute value.

If an error condition occurs, this routine returns -1 and sets errno to the corresponding error value. Possible return values are as follows:

Return Error Description

Guardsize Successful completion. attribute -1 [EINVAL] The value specified by attr is invalid.