1m_getvalues_layout(3LAYOLUaTy)out Service Library Functimo_ngsetvalues_layout(3LAYOUT)
2
3
4

NAME

6       m_getvalues_layout - query layout values of a LayoutObject
7

SYNOPSIS

9       cc [ flag... ] file... -llayout [ library... ]
10       #include <sys/layout.h>
11
12       int m_getvalues_layout(const LayoutObject
13            layout_object, LayoutValues values, int *index_returned);
14
15

DESCRIPTION

17       The m_getvalues_layout() function queries the current setting of layout
18       values within a LayoutObject.
19
20
21       The layout_object argument specifies a  LayoutObject  returned  by  the
22       m_create_layout(3LAYOUT) function.
23
24
25       The  values argument specifies the list of layout values that are to be
26       queried. Each value element of a LayoutValueRec must point to  a  loca‐
27       tion  where the layout value is stored. That is, if the layout value is
28       of type T, the argument must be of type T*. The values are queried from
29       the LayoutObject and represent its current state.
30
31
32       It  is the user's responsibility to manage the space allocation for the
33       layout values queried. If the layout value name has QueryValueSize  OR-
34       ed  to  it,  instead of the value of the layout value, only its size is
35       returned. The caller can use this option to  determine  the  amount  of
36       memory needed to be allocated for the layout values queried.
37

RETURN VALUES

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

ERRORS

45       The m_getvalues_layout() function may fail if:
46
47       EINVAL    The layout value specified by index_returned is unknown,  its
48                 value  is  invalid, or the layout_object argument is invalid.
49                 In the case of an invalid layout_object argument,  the  value
50                 returned in index_returned is −1.
51
52

ATTRIBUTES

54       See attributes(5) for descriptions of the following attributes:
55
56
57
58
59       ┌─────────────────────────────┬─────────────────────────────┐
60       │      ATTRIBUTE TYPE         │      ATTRIBUTE VALUE        │
61       ├─────────────────────────────┼─────────────────────────────┤
62       │Interface Stability          │Standard                     │
63       ├─────────────────────────────┼─────────────────────────────┤
64       │MT-Level                     │MT-Safe                      │
65       └─────────────────────────────┴─────────────────────────────┘
66

SEE ALSO

68       m_create_layout(3LAYOUT), attributes(5), standards(5)
69
70
71
72SunOS 5.11                        7 Aug 2006       m_getvalues_layout(3LAYOUT)
Impressum