screen_destroy_buffer()

Destroy a buffer and frees associated resources

Function type:

Immediate execution

Synopsis:

#include <screen/screen.h>

int screen_destroy_buffer( screen_buffer_t buf );

Arguments:

buf
The handle of the buffer that you want to destroy. This buffer must have been created with screen_create_buffer().

Library:

screen

Description:

This function destroys the buffer object associated with the buffer handle. Any resources created for this buffer will be released. The buffer handle can no longer be used as argument in subsequent screen calls. The actual memory buffer described by this buffer handle is not released by this operation. The application is responsible for freeing its own external buffers. Only buffers created with screen_create_buffer() should be destroyed with this function.

Returns:

If the function succeeds, it returns 0 and the buffer is destroyed. Otherwise, the function returns -1 and errno is set.

Classification:

Windowing API

Safety  Value  
Interrupt handler No
Signal handler No
Thread Yes