Layout Service Library Functions      mgetvalueslayout(3LAYOUT)



NAME
     mgetvalueslayout - query layout values of a LayoutObject

SYNOPSIS
     cc [ flag... ] file... -llayout [ library... ]
     #include 

     int mgetvalueslayout(const LayoutObject
          layoutobject, LayoutValues values, int *indexreturned);


DESCRIPTION
     The mgetvalueslayout() function queries the  current  set-
     ting of layout values within a LayoutObject.


     The layoutobject argument specifies a LayoutObject returned
     by the mcreatelayout(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  alloca-
     tion 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  mgetvalueslayout()  func-
     tion returns 0. If any value cannot be queried, the index of
     the value causing the error is returned  in  indexreturned,
     -1 is returned and errno is set to indicate the error.

ERORS
     The mgetvalueslayout() function may fail if:

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






SunOS 5.11           Last change: 7 Aug 2006                    1






Layout Service Library Functions      mgetvalueslayout(3LAYOUT)



ATRIBUTES
     See attributes(5) for descriptions of the  following  attri-
     butes:



     
           ATRIBUTE TYPE               ATRIBUTE VALUE       
    
     Interface Stability          Standard                    
    
     MT-Level                     MT-Safe                     
    


SEE ALSO
     mcreatelayout(3LAYOUT), attributes(5), standards(5)






































SunOS 5.11           Last change: 7 Aug 2006                    2