cursscanw(3X) cursscanw(3X)

NAME
       ssccaannww, wwssccaannww, mmvvssccaannww, mmvvwwssccaannww, vvwwssccaannww, vvwwssccaannww - convert formatted
       input from a ccuurrsseess window

SYNOPSIS
       ##iinncclluuddee <>

       iinntt ssccaannww((cchhaarr **ffmmtt,, ......));;
       iinntt wwssccaannww((WWIINNDDOOWW **wwiinn,, cchhaarr **ffmmtt,, ......));;
       iinntt mmvvssccaannww((iinntt yy,, iinntt xx,, cchhaarr **ffmmtt,, ......));;
       iinntt mmvvwwssccaannww((WWIINNDDOOWW **wwiinn,, iinntt yy,, iinntt xx,, cchhaarr **ffmmtt,, ......));;
       iinntt vvwwssccaannww((WWIINNDDOOWW **wwiinn,, cchhaarr **ffmmtt,, vvaalliisstt vvaarrgglliisstt));;
       iinntt vvwwssccaannww((WWIINNDDOOWW **wwiinn,, cchhaarr **ffmmtt,, vvaalliisstt vvaarrgglliisstt));;

DESCRIPTION
       The ssccaannww, wwssccaannww and mmvvssccaannww routines  are  analogous  to  ssccaannff  [see
       ssccaannff(3S)].   The  effect  of  these routines is as though wwggeettssttrr were
       called on the  window,  and  the  resulting  line  used  as  input  for
       ssssccaannff(3).   Fields which do not map to a variable in the fmt field are
       lost.

       The vvwwssccaannww and vvwwssccaannww routines are analogous to vvssccaannff.   They  per-
       form  a wwssccaannww using a variable argument list.  The third argument is a
       valist, a pointer to a list of arguments, as defined in <>.

RREETTUURRNN VVAALLUUEE
       vvwwssccaannww returns EERRRR on failure and an integer equal to  the  number  of
       fields scanned on success.

       Applications  may  use the return value from the ssccaannww, wwssccaannww, mmvvssccaannww
       and mmvvwwssccaannww routines to determine the  number  of  fields  which  were
       mapped in the call.

PPOORRTTAABBIILLIITTYY
       The  XSI Curses standard, Issue 4 describes these functions.  The func-
       tion vvwwssccaannww is marked TO BE WITHDRAWN, and is  to  be  replaced  by  a
       function  vvwwssccaannww  using  the  <>  interface.  The Single Unix
       Specification, Version 2 states that vvwwssccaannww  is preferred to  vvwwssccaannww
       since  the  latter requires including <>, which cannot be used
       in the same file as <>.  This  implementation  uses  <>
       for both, because that header is included in <.

       Both  XSI and The Single Unix Specification, Version 2 state that these
       functions return ERR or OK.  Since the underlying ssccaannff can return  the
       number  of  items scanned, and the SVr4 code was documented to use this
       feature, this is probably an editing error which was introduced in XSI,
       rather  than  being  done  intentionally.  Portable applications should
       only test if the return value is ERR, since  the  OK  value  (zero)  is
       likely  to be misleading.  One possible way to get useful results would
       be to use a "%n" conversion at the end of the format string  to  ensure
       that something was processed.

SEE ALSO
       ccuurrsseess(3X), ccuurrssggeettssttrr(3X), ccuurrsspprriinnttww(3X), ssccaannff(3S)



                                                                cursscanw(3X)