layout_object_free Subroutine
Purpose
Frees a LayoutObject structure.
Library
Layout library (libi18n.a)
Syntax
#include <sys/lc_layout.h>int layout_object_free(layout_object)
LayoutObject layout_object;
LayoutObject layout_object;
Description
The layout_object_free subroutine releases all the resources of the LayoutObject structure created by the layout_object_create subroutine. The layout_object parameter specifies this LayoutObject structure.
Note: If you are
developing internationalized applications that may support multibyte
locales, please see Use
of the libcur Package in General Programming Concepts: Writing and Debugging Programs
Parameters
| Item | Description |
|---|---|
| layout_object | Specifies a LayoutObject structure returned by the layout_object_create subroutine. |
Return Values
Upon successful completion, the layout_object_free subroutine returns a value of 0. All resources associated with the layout_object parameter are successfully deallocated.
Error Codes
If the layout_object_free subroutine fails, it returns the following error code:
| Item | Description |
|---|---|
| LAYOUT_EFAULT | Errors occurred while processing the request. |