home *** CD-ROM | disk | FTP | other *** search
/ IRIX Base Documentation 2002 November / SGI IRIX Base Documentation 2002 November.iso / usr / share / catman / p_man / cat3 / SCSetup.z / SCSetup
Encoding:
Text File  |  2002-10-03  |  6.3 KB  |  133 lines
  1.  
  2.  
  3.  
  4. SSSSCCCCSSSSeeeettttuuuupppp((((3333))))                       IIIImmmmpppprrrreeeessssssssaaaarrrriiiioooo                        SSSSCCCCSSSSeeeettttuuuupppp((((3333))))
  5.  
  6.  
  7.  
  8. NNNNAAAAMMMMEEEE
  9.      SCSetup - set scanning parameters
  10.  
  11. SSSSYYYYNNNNOOOOPPPPSSSSIIIISSSS
  12.      ####iiiinnnncccclllluuuuddddeeee <<<<ssssttttddddiiiioooo....hhhh>>>>
  13.      ####iiiinnnncccclllluuuuddddeeee <<<<ssssccccaaaannnnnnnneeeerrrr....hhhh>>>>
  14.  
  15.      iiiinnnntttt SSSSCCCCSSSSeeeettttuuuupppp((((SSSSCCCCAAAANNNNNNNNEEEERRRR ****ssss,,,, iiiinnnntttt pppprrrreeeevvvviiiieeeewwww,,,, SSSSCCCCDDDDAAAATTTTAAAATTTTYYYYPPPPEEEE ****ttttyyyyppppeeee,,,,
  16.                  iiiinnnntttt rrrrmmmmeeeettttrrrriiiicccc,,,, ffffllllooooaaaatttt xxxxrrrreeeessss,,,, ffffllllooooaaaatttt yyyyrrrreeeessss,,,,
  17.                  iiiinnnntttt wwwwmmmmeeeettttrrrriiiicccc,,,, ffffllllooooaaaatttt xxxx,,,, ffffllllooooaaaatttt yyyy,,,, ffffllllooooaaaatttt wwwwiiiiddddtttthhhh,,,, ffffllllooooaaaatttt hhhheeeeiiiigggghhhhtttt))));;;;
  18.  
  19. DDDDEEEESSSSCCCCRRRRIIIIPPPPTTTTIIIIOOOONNNN
  20.      _S_C_S_e_t_u_p transfers scanning parameters to the scanner driver, in
  21.      preparation for a subsequent call to _S_C_S_c_a_n or _S_C_S_c_a_n_F_D.
  22.  
  23.      _s specifies a connection to a scanner driver obtained from a call to
  24.      _S_C_O_p_e_n(3), _S_C_O_p_e_n_F_i_l_e(3), or _S_C_O_p_e_n_S_c_r_e_e_n(3).
  25.  
  26.      _p_r_e_v_i_e_w should be non-zero if these are parameters are for a preview, or
  27.      0 if they are for a final scan.  If set, this flag is an indication to
  28.      the driver to prefer speed over image quality in order to enable a fast
  29.      preview mode.  If _p_r_e_v_i_e_w is zero, the scanner driver is instructed to
  30.      prefer image quality over speed.
  31.  
  32.      _t_y_p_e is the type of data to be scanned.  It must be one of the types
  33.      supported by the scanner.  See _S_C_G_e_t_D_a_t_a_T_y_p_e_s(3) for information on
  34.      determining which types are supported by a scanner.
  35.  
  36.      _r_m_e_t_r_i_c is set to either SSSSCCCC____IIIINNNNCCCCHHHHEEEESSSS or SSSSCCCC____CCCCEEEENNNNTTTTIIIIMMMM, depending on whether the
  37.      resolution is specified in inches or centimeters.  _x_r_e_s specifies the
  38.      horizontal scanning resolution, and _y_r_e_s specifies the vertical scanning
  39.      resolution.  _x_r_e_s and _y_r_e_s must be within the limits supported by the
  40.      scanner driver.  See _S_C_G_e_t_M_i_n_M_a_x_R_e_s(3) for information about getting
  41.      these limits.
  42.  
  43.      _w_m_e_t_r_i_c is set to either SSSSCCCC____PPPPIIIIXXXXEEEELLLLSSSS, SSSSCCCC____IIIINNNNCCCCHHHHEEEESSSS, or SSSSCCCC____CCCCEEEENNNNTTTTIIIIMMMM, depending on
  44.      whether the scan area is specified in pixels, inches, or centimeters.  _x
  45.      and _y specify the coordinates of the upper left corner of the scan area,
  46.      and _w_i_d_t_h and _h_e_i_g_h_t specify the size of the scanning area.  The scanning
  47.      area must lie within the scannable area supported by the scanner.  See
  48.      _S_C_G_e_t_P_a_g_e_S_i_z_e(3) for information about getting the scannable area.
  49.  
  50.      If _w_m_e_t_r_i_c is set to SSSSCCCC____PPPPIIIIXXXXEEEELLLLSSSS, the scanner driver is required to return
  51.      exactly _w_i_d_t_h pixels per scan line and exactly _h_e_i_g_h_t scan lines when
  52.      scanning.
  53.  
  54.      After calling _S_C_S_e_t_u_p, _S_C_G_e_t_S_c_a_n_S_i_z_e(_3) should be called to determine the
  55.      actual size in pixels of the scanning area, and then _S_C_S_c_a_n(3) or
  56.      _S_C_S_c_a_n_F_D(3) should be called to start scanning.
  57.  
  58.  
  59.  
  60.  
  61.  
  62.  
  63.                                                                         PPPPaaaaggggeeee 1111
  64.  
  65.  
  66.  
  67.  
  68.  
  69.  
  70. SSSSCCCCSSSSeeeettttuuuupppp((((3333))))                       IIIImmmmpppprrrreeeessssssssaaaarrrriiiioooo                        SSSSCCCCSSSSeeeettttuuuupppp((((3333))))
  71.  
  72.  
  73.  
  74. RRRREEEETTTTUUUURRRRNNNN VVVVAAAALLLLUUUUEEEE
  75.      _S_C_S_e_t_u_p returns 0 if successful.  If an error occurs, _S_C_S_e_t_u_p returns -1
  76.      and sets _S_C_e_r_r_n_o to indicate the cause of the error.
  77.  
  78. EEEEXXXXEEEECCCCUUUUTTTTIIIIOOOONNNN EEEERRRRRRRROOOORRRR CCCCOOOODDDDEEEESSSS
  79.      _S_C_S_e_t_u_p will fail under the following circumstances.
  80.  
  81.      SCENOTSUPPORTED          Unsupported operation
  82.  
  83.      SCEBADTYPE               Illegal data type specified
  84.  
  85.      SCENOMEM                 Out of memory
  86.  
  87.      SCEBADRES                Unsupported resolution specified
  88.  
  89.      SCEBADPARAM              Bad scanning parameter
  90.  
  91.      SCEBADMETRIC             Unsupported metric
  92.  
  93.      SCEDEV                   Scanner driver error
  94.  
  95.      SCECOMM                  Error communicating with scanner driver
  96.  
  97.      SCEDRVMSG                Driver specific error.  _S_C_E_r_r_o_r_S_t_r_i_n_g(3) will
  98.                               return a custom message supplied by the scanner
  99.                               driver
  100.  
  101. SSSSEEEEEEEE AAAALLLLSSSSOOOO
  102.      _l_i_b_s_c_a_n(3), _S_C_O_p_e_n(3), _S_C_G_e_t_D_a_t_a_T_y_p_e_s(3), _S_C_G_e_t_S_c_a_n_n_e_r_R_e_s(3),
  103.      _S_C_G_e_t_M_i_n_M_a_x_R_e_s(3), _S_C_G_e_t_P_a_g_e_S_i_z_e(3), _S_C_S_c_a_n(3), _S_C_S_c_a_n_F_D(3).
  104.  
  105.  
  106.  
  107.  
  108.  
  109.  
  110.  
  111.  
  112.  
  113.  
  114.  
  115.  
  116.  
  117.  
  118.  
  119.  
  120.  
  121.  
  122.  
  123.  
  124.  
  125.  
  126.  
  127.  
  128.  
  129.                                                                         PPPPaaaaggggeeee 2222
  130.  
  131.  
  132.  
  133.