'\" te
.\" Copyright (c) 1996, The Open Group. All Rights Reserved.
.\" Portions Copyright (c) 2008, 2014, Oracle and/or its affiliates. All rights reserved.
.\" The Open Group have given us permission to reprint portions of their documentation. In the following statement, the phrase "this text" refers to portions of the system documentation. Portions of this text are reprinted and reproduced in electronic form in the Sun OS Reference Manual, from The Open Group Technical Standard Portable Layout Services: Context-Dependent and Directional Text ISBN 1-85912-142-X In the event of any discrepancy between this version and the original specification, the original Open Group Standard is the referee document. The original document can be obtained online at http://www.opengroup.org/bookstore/ .
.TH m_getvalues_layout 3LAYOUT "24 Apr 2014" "SunOS 5.11" "Layout Service Library Functions"
.SH NAME
m_getvalues_layout \- query layout values of a LayoutObject
.SH SYNOPSIS
.LP
.nf
cc [ \fIflag\fR... ] \fIfile\fR... -llayout [ \fIlibrary\fR... ]
#include <sys/layout.h>

\fBint\fR \fBm_getvalues_layout\fR(\fBconst LayoutObject\fR
     \fIlayout_object\fR, \fBLayoutValues\fR \fIvalues\fR, \fBint *\fR\fIindex_returned\fR);
.fi

.SH DESCRIPTION
.sp
.LP
The \fBm_getvalues_layout()\fR function queries the current setting of layout values within a \fBLayoutObject\fR. 
.sp
.LP
The \fIlayout_object\fR argument specifies a \fBLayoutObject\fR returned by the \fBm_create_layout\fR(3LAYOUT) function.
.sp
.LP
The \fIvalues\fR argument specifies the list of layout values that are to be queried. Each value element of a \fBLayoutValueRec\fR must point to a location where the layout value is stored. That is, if the layout value is of type \fBT\fR, the argument must be of type \fBT*\fR. The values are queried from the \fBLayoutObject\fR and represent its current state. 
.sp
.LP
It is the user's responsibility to manage the space allocation for the layout values queried. If the layout value name has \fBQueryValueSize\fR 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.
.SH RETURN VALUES
.sp
.LP
Upon successful completion, the \fBm_getvalues_layout()\fR function returns \fB0\fR. If any value cannot be queried, the index of the value causing the error is returned in \fIindex_returned\fR, \fB\(mi1\fR is returned and \fBerrno\fR is set to indicate the error.
.SH ERRORS
.sp
.LP
The \fBm_getvalues_layout()\fR function may fail if:
.sp
.ne 2
.mk
.na
\fB\fBEINVAL\fR\fR
.ad
.RS 10n
.rt  
The layout value specified by \fIindex_returned\fR is unknown, its value is invalid, or the \fIlayout_object\fR argument is invalid. In the case of an invalid \fIlayout_object\fR argument, the value returned in \fIindex_returned\fR is \fB\(mi1\fR\&.
.RE

.SH ATTRIBUTES
.sp
.LP
See \fBattributes\fR(5) for descriptions of the following attributes:
.sp

.sp
.TS
tab() box;
cw(2.75i) |cw(2.75i) 
lw(2.75i) |lw(2.75i) 
.
ATTRIBUTE TYPEATTRIBUTE VALUE
_
Interface StabilityCommitted
_
MT-LevelMT-Safe
_
StandardSee \fBstandards\fR(5).
.TE

.SH SEE ALSO
.sp
.LP
\fBm_create_layout\fR(3LAYOUT), \fBattributes\fR(5), \fBstandards\fR(5)