m_setvalues_layout() — Set layout values of a layout object (bidi data)

Standards

Standards / Extensions C or C++ Dependencies

ISO C
XPG4
C99

 both z/OS V1R2

Format

#include <sys/layout.h>

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

General description

The m_setvalues_layout() function is part of the support for handling of bidirectional (Bidi) conversion of data between Visual (MVS™) and Implicit (z/OS® UNIX) formats. Initial support is for Arabic and Hebrew data.

The m_setvalues_layout() function is used to change the layout values of a LayoutObject. The layout_object argument specifies a LayoutObject returned by the m_create_layout() function. The values argument specifies the list of layout values which are to be changed. The values are written into the LayoutObject and may affect the behavior of subsequent layout functions.

Note: Some layout values do alter internal states maintained by a LayoutObject. The m_setvalues_layout() function can be implemented as a macro that evaluates the first argument twice.

Returned value

If successful, m_setvalues_layout() sets the requested layout values and returns 0.

If any value cannot be set, m_setvalues_layout() does not change any of the layout values. It stores into index_returned the (zero-based) index of the value causing the error. It returns -1 and sets errno to one of the following values:

Error Code
Description
EINVAL
The layout value specified by index_returned is unknown or its value is invalid or the argument layout_object is invalid.

Related information

Parent topic: Library functions