m_create_layout(3layout) [opensolaris man page]

m_create_layout(3LAYOUT)				 Layout Service Library Functions				  m_create_layout(3LAYOUT)

NAME

       m_create_layout - initialize a layout object

SYNOPSIS

       cc [ flag... ] file... -llayout [ library... ]
       #include <sys/layout.h>

       LayoutObject m_create_layout(const AttrObject attrobj,
	     const char*modifier);

DESCRIPTION

       The m_create_layout() function creates a LayoutObject associated with the locale identified by attrobj.

       The LayoutObject is an opaque object containing all the data and methods necessary to perform the layout operations on context-dependent or
       directional characters of the locale identified by the attrobj. The memory for the LayoutObject is allocated by m_create_layout(). The Lay-
       outObject  created  has	default layout values. If the modifier argument is not NULL, the layout values specified by the modifier overwrite
       the default layout values associated with the locale.  Internal states maintained by the layout transformation function across  transforma-
       tions are set to their initial values.

       The  attrobj argument is or may be an amalgam of many opaque objects. A locale object is just one example of the type of object that can be
       attached to an attribute object. The attrobj argument specifies a name that is usually associated with a locale	category.  If  attrobj	is
       NULL, the created LayoutObject is associated with the current locale as set by the setlocale(3C) function.

       The modifier argument announces a set of layout values when the LayoutObject is created.

RETURN VALUES

       Upon  successful  completion,  the m_create_layout() function returns a LayoutObject for use in subsequent calls to m_*_layout() functions.
       Otherwise the m_create_layout() function returns (LayoutObject) 0 and sets errno to indicate the error.

ERRORS

       The m_create_layout() function may fail if:

       EBADF	 The attribute object is invalid or the locale asssociated with the attribute object is not available.

       EINVAL	 The modifier string has a syntax error or it contains unknown layout values.

       EMFILE	 There are {OPEN_MAX} file descriptors currently open in the calling process.

       ENOMEM	 Insufficient storage space is available.

ATTRIBUTES

       See attributes(5) for descriptions of the following attributes:

       +-----------------------------+-----------------------------+
       |      ATTRIBUTE TYPE	     |	    ATTRIBUTE VALUE	   |
       +-----------------------------+-----------------------------+
       |Interface Stability	     |Standard			   |
       +-----------------------------+-----------------------------+
       |MT-Level		     |MT-Safe			   |
       +-----------------------------+-----------------------------+

SEE ALSO

       setlocale(3C), attributes(5), standards(5)

SunOS 5.11							    7 Aug 2006						  m_create_layout(3LAYOUT)

Check Out this Related Man Page

m_getvalues_layout(3LAYOUT)				 Layout Service Library Functions			       m_getvalues_layout(3LAYOUT)

NAME

       m_getvalues_layout - query layout values of a LayoutObject

SYNOPSIS

       cc [ flag... ] file... -llayout [ library... ]
       #include <sys/layout.h>

       int m_getvalues_layout(const LayoutObject layout_object, LayoutValues values, int *index_returned);

DESCRIPTION

       The m_getvalues_layout() function queries the current setting of layout values within a LayoutObject.

       The layout_object argument specifies a LayoutObject returned by the m_create_layout(3LAYOUT) function.

       The  values  argument  specifies  the  list of layout values that are to be queried. Each value element of a LayoutValueRec must point to a
       location where the layout value is stored. That is, if the layout value is of type T, the argument must be  of  type  T*.  The  values  are
       queried from the LayoutObject and represent its current state.

       It  is  the user's responsibility to manage the space allocation for the layout values queried. If the layout value name has QueryValueSize
       OR-ed to it, instead of the value of the layout value, only its size is returned. The caller can use this option to determine the amount of
       memory needed to be allocated for the layout values queried.

RETURN VALUES

       Upon successful completion, the m_getvalues_layout() function returns 0. If any value cannot be queried, the index of the value causing the
       error is returned in index_returned, -1 is returned and errno is set to indicate the error.

ERRORS

       The m_getvalues_layout() function may fail if:

       EINVAL	       The layout value specified by index_returned is unknown, its value is invalid, or the layout_object argument is invalid. In
		       the case of an invalid layout_object argument, the value returned in index_returned is -1.

ATTRIBUTES

       See attributes(5) for descriptions of the following attributes:

       +-----------------------------+-----------------------------+
       |      ATTRIBUTE TYPE	     |	    ATTRIBUTE VALUE	   |
       +-----------------------------+-----------------------------+
       |MT-Level		     |MT-Safe			   |
       +-----------------------------+-----------------------------+

SEE ALSO

       m_create_layout(3LAYOUT), attributes(5)

SunOS 5.10							    8 Jun 1999					       m_getvalues_layout(3LAYOUT)

Linux and UNIX Man Pages

m_create_layout(3layout) [opensolaris man page]

Check Out this Related Man Page