[ Previous | Next | Table of Contents | Index | Library Home | Legal | Search ]

Technical Reference: Base Operating System and Extensions, Volume 1


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;

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 AIX 5L Version 5.1 General Programming Concepts: Writing and Debugging Programs

Parameters


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:

LAYOUT_EFAULT Errors occurred while processing the request.

Implementation Specifics

This subroutine is part of Base Operating System (BOS) Runtime.

Related Information

The layout_object_create (layout_object_create Subroutine) subroutine, layout_object_editshape (layout_object_editshape or wcslayout_object_editshape Subroutine) subroutine, layout_object_getvalue (layout_object_getvalue Subroutine) subroutine, layout_object_setvalue (layout_object_setvalue Subroutine) subroutine, layout_object_shapeboxchars (layout_object_shapeboxchars Subroutine) subroutine, layout_object_transform (layout_object_transform or wcslayout_object_transform Subroutine) subroutine.

Bidirectionality and Arabic Character Shaping Overview in AIX 5L Version 5.1 General Programming Concepts: Writing and Debugging Programs.

National Language Support Overview for Programming in AIX 5L Version 5.1 General Programming Concepts: Writing and Debugging Programs.


[ Previous | Next | Table of Contents | Index | Library Home | Legal | Search ]