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 / Xvc / XSGIvcSendMonitorCommand.z / XSGIvcSendMonitorCommand
Encoding:
Text File  |  2002-10-03  |  11.6 KB  |  199 lines
  1.  
  2.  
  3.  
  4.      XXXXSSSSGGGGIIIIvvvvccccSSSSeeeennnnddddMMMMoooonnnniiiittttoooorrrrCCCCoooommmmmmmmaaaannnndddd((((3333))))           XXXXSSSSGGGGIIIIvvvvccccSSSSeeeennnnddddMMMMoooonnnniiiittttoooorrrrCCCCoooommmmmmmmaaaannnndddd((((3333))))
  5.  
  6.  
  7.  
  8.      NNNNAAAAMMMMEEEE
  9.           XSGIvcSendMonitorCommand, XSGIvcSendMonitorQuery,
  10.           XSGIvcQueryMonitorBaseProtocol,
  11.           XSGIvcInitMonitorBaseProtocol - Monitor control
  12.  
  13.      SSSSYYYYNNNNOOOOPPPPSSSSIIIISSSS
  14.           ####iiiinnnncccclllluuuuddddeeee <<<<XXXX11111111////eeeexxxxtttteeeennnnssssiiiioooonnnnssss////XXXXSSSSGGGGIIIIvvvvcccc....hhhh>>>>
  15.  
  16.           vvvvooooiiiidddd XXXXSSSSGGGGIIIIvvvvccccSSSSeeeennnnddddMMMMoooonnnniiiittttoooorrrrCCCCoooommmmmmmmaaaannnndddd((((DDDDiiiissssppppllllaaaayyyy ****ddddiiiissssppppllllaaaayyyy,,,,
  17.               iiiinnnntttt ssssccccrrrreeeeeeeennnn,,,,
  18.               iiiinnnntttt cccchhhhaaaannnnnnnneeeellll,,,,
  19.               ccccoooonnnnsssstttt cccchhhhaaaarrrr ****mmmmoooonnnniiiittttoooorrrrCCCCoooommmmmmmmaaaannnndddd,,,,
  20.               iiiinnnntttt ccccoooommmmmmmmaaaannnnddddLLLLeeeennnnggggtttthhhh))))
  21.  
  22.           SSSSttttaaaattttuuuussss XXXXSSSSGGGGIIIIvvvvccccSSSSeeeennnnddddMMMMoooonnnniiiittttoooorrrrQQQQuuuueeeerrrryyyy((((DDDDiiiissssppppllllaaaayyyy ****ddddiiiissssppppllllaaaayyyy,,,,
  23.               iiiinnnntttt ssssccccrrrreeeeeeeennnn,,,,
  24.               iiiinnnntttt cccchhhhaaaannnnnnnneeeellll,,,,
  25.               ccccoooonnnnsssstttt cccchhhhaaaarrrr ****mmmmoooonnnniiiittttoooorrrrCCCCoooommmmmmmmaaaannnndddd,,,,
  26.               iiiinnnntttt ccccoooommmmmmmmaaaannnnddddLLLLeeeennnnggggtttthhhh,,,,
  27.               cccchhhhaaaarrrr ********mmmmoooonnnniiiittttoooorrrrRRRReeeessssppppoooonnnnsssseeee,,,,
  28.               iiiinnnntttt ****rrrreeeessssppppoooonnnnsssseeeeLLLLeeeennnnggggtttthhhh))))
  29.  
  30.           iiiinnnntttt XXXXSSSSGGGGIIIIvvvvccccQQQQuuuueeeerrrryyyyMMMMoooonnnniiiittttoooorrrrBBBBaaaasssseeeePPPPrrrroooottttooooccccoooollll((((DDDDiiiissssppppllllaaaayyyy ****ddddiiiissssppppllllaaaayyyy,,,,
  31.               iiiinnnntttt ssssccccrrrreeeeeeeennnn,,,,
  32.               iiiinnnntttt cccchhhhaaaannnnnnnneeeellll))))
  33.  
  34.           vvvvooooiiiidddd XXXXSSSSGGGGIIIIvvvvccccIIIInnnniiiittttMMMMoooonnnniiiittttoooorrrrBBBBaaaasssseeeePPPPrrrroooottttooooccccoooollll((((DDDDiiiissssppppllllaaaayyyy ****ddddiiiissssppppllllaaaayyyy,,,,
  35.               iiiinnnntttt ssssccccrrrreeeeeeeennnn,,,,
  36.               iiiinnnntttt cccchhhhaaaannnnnnnneeeellll))))
  37.  
  38.      PPPPAAAARRRRAAAAMMMMEEEETTTTEEEERRRRSSSS
  39.           _d_i_s_p_l_a_y        Specifies the connection to the X server.
  40.  
  41.           _s_c_r_e_e_n         Specifies the screen of the X server.
  42.  
  43.           _c_h_a_n_n_e_l        Specifies the channel number.
  44.  
  45.           _m_o_n_i_t_o_r_C_o_m_m_a_n_d The command to be sent to the monitor.  The
  46.                          command sequence must be a valid command
  47.                          packet that will be sent unprocessed to the
  48.                          monitor connected to cccchhhhaaaannnnnnnneeeellll.
  49.  
  50.           _c_o_m_m_a_n_d_L_e_n_g_t_h  The length, in bytes, of _m_o_n_i_t_o_r_C_o_m_m_a_n_d.
  51.  
  52.           _m_o_n_i_t_o_r_R_e_s_p_o_n_s_e
  53.                          Returns a pointer to a buffer containing the
  54.                          response returned from the monitor. This
  55.                          response will be returned unprocessed.
  56.  
  57.           _r_e_s_p_o_n_s_e_L_e_n_g_t_h The length, in bytes, of _m_o_n_i_t_o_r_R_e_s_p_o_n_s_e.
  58.  
  59.  
  60.  
  61.  
  62.  
  63.      Page 1                                          (printed 10/3/02)
  64.  
  65.  
  66.  
  67.  
  68.  
  69.  
  70.      XXXXSSSSGGGGIIIIvvvvccccSSSSeeeennnnddddMMMMoooonnnniiiittttoooorrrrCCCCoooommmmmmmmaaaannnndddd((((3333))))           XXXXSSSSGGGGIIIIvvvvccccSSSSeeeennnnddddMMMMoooonnnniiiittttoooorrrrCCCCoooommmmmmmmaaaannnndddd((((3333))))
  71.  
  72.  
  73.  
  74.      DDDDEEEESSSSCCCCRRRRIIIIPPPPTTTTIIIIOOOONNNN
  75.           These functions allow an application program to communicate
  76.           with a monitor that has the capability to send and receive
  77.           such commands.  Client programs are responsible for
  78.           composing monitor commands and for parsing the result; the X
  79.           server simply transports strings between the client and
  80.           monitor.
  81.  
  82.           This function is intended for server-to-monitor
  83.           communications.  Servers do not guarantee that other devices
  84.           connected to the bus will function properly, nor will the
  85.           bus connecting a monitor always be active; spontaneous
  86.           messages from monitors or other devices can be ignored.
  87.  
  88.  
  89.         FFFFuuuunnnnccccttttiiiioooonnnnssss
  90.           XXXXSSSSGGGGIIIIvvvvccccSSSSeeeennnnddddMMMMoooonnnniiiittttoooorrrrCCCCoooommmmmmmmaaaannnndddd sends a command - for which no
  91.           response is expected - to the monitor of the specified
  92.           channel.
  93.  
  94.           If a response is expected, use XXXXSSSSGGGGIIIIvvvvccccSSSSeeeennnnddddMMMMoooonnnniiiittttoooorrrrQQQQuuuueeeerrrryyyy which
  95.           sends a command to the monitor of the specified channel and
  96.           waits for a response before continuing.  The response is
  97.           placed in a buffer whose address is returned in
  98.           _m_o_n_i_t_o_r_R_e_s_p_o_n_s_e.  The client is responsible for calling
  99.           XXXXFFFFrrrreeeeeeee on the memory allocated by the library.
  100.  
  101.           The XXXXSSSSGGGGIIIIvvvvccccIIIInnnniiiittttMMMMoooonnnniiiittttoooorrrrBBBBaaaasssseeeePPPPrrrroooottttooooccccoooollll function must be called to
  102.           initialize the protocol the server is going to use to
  103.           communicate with the monitor before any commands or queries
  104.           are sent to the monitor. This function reinitializes the
  105.           monitor protocol each time it is called, and may be called
  106.           at any time. XXXXSSSSGGGGIIIIvvvvccccQQQQuuuueeeerrrryyyyMMMMoooonnnniiiittttoooorrrrBBBBaaaasssseeeePPPPrrrroooottttooooccccoooollll may be called to
  107.           find out if the protocol has already been initialized (see
  108.           below).
  109.  
  110.           The XXXXSSSSGGGGIIIIvvvvccccQQQQuuuueeeerrrryyyyMMMMoooonnnniiiittttoooorrrrBBBBaaaasssseeeePPPPrrrroooottttooooccccoooollll function returns a
  111.           description of the protocol the X-Server will use to
  112.           communicate with the monitor.  The following are defined:
  113.  
  114.           _X_S_G_I_V_C__M_B_P_U_n_i_n_i_t_i_a_l_i_z_e_d
  115.                                 The protocol between the server and
  116.                                 the monitor has not yet been
  117.                                 initialized. Implies that the client
  118.                                 must first call
  119.                                 XXXXSSSSGGGGIIIIvvvvccccIIIInnnniiiittttMMMMoooonnnniiiittttoooorrrrBBBBaaaasssseeeePPPPrrrroooottttooooccccoooollll in order
  120.                                 to get a valid response.
  121.  
  122.           _X_S_G_I_V_C__M_B_P_N_o_n_e        The server or monitor does not support
  123.                                 monitor commands on this channel.
  124.  
  125.           _X_S_G_I_V_C__M_B_P_A_c_c_e_s_s_B_u_s   The server will use ACCESS.bus
  126.  
  127.  
  128.  
  129.      Page 2                                          (printed 10/3/02)
  130.  
  131.  
  132.  
  133.  
  134.  
  135.  
  136.      XXXXSSSSGGGGIIIIvvvvccccSSSSeeeennnnddddMMMMoooonnnniiiittttoooorrrrCCCCoooommmmmmmmaaaannnndddd((((3333))))           XXXXSSSSGGGGIIIIvvvvccccSSSSeeeennnnddddMMMMoooonnnniiiittttoooorrrrCCCCoooommmmmmmmaaaannnndddd((((3333))))
  137.  
  138.  
  139.  
  140.                                 communications protocol. The content
  141.                                 of message buffers referenced by
  142.                                 _m_o_n_i_t_o_r_C_o_m_m_a_n_d and _m_o_n_i_t_o_r_R_e_s_p_o_n_s_e
  143.                                 begin with ACCESS.bus primary opcode.
  144.                                 During its initialization, the server
  145.                                 will switch connected monitors from
  146.                                 VESA DDC1/2AB to ACCESS.bus
  147.                                 communications mode.
  148.  
  149.  
  150.      EEEEVVVVEEEENNNNTTTTSSSS
  151.           No events.
  152.  
  153.  
  154.  
  155.      RRRREEEETTTTUUUURRRRNNNNEEEEDDDD VVVVAAAALLLLUUUUEEEE
  156.           A _B_a_d_A_c_c_e_s_s error indicates a breakdown in the monitor
  157.           protocol, and that the client must call
  158.           XXXXSSSSGGGGIIIIvvvvccccIIIInnnniiiittttMMMMoooonnnniiiittttoooorrrrBBBBaaaasssseeeePPPPrrrroooottttooooccccoooollll in order to re-establish
  159.           communications with the monitor.  In addition, a _B_a_d_A_c_c_e_s_s
  160.           error will result from a send monitor command or query call
  161.           when XXXXSSSSGGGGIIIIvvvvccccQQQQuuuueeeerrrryyyyMMMMoooonnnniiiittttoooorrrrBBBBaaaasssseeeePPPPrrrroooottttooooccccoooollll has returned
  162.           _X_S_G_I_V_C__M_B_P_N_o_n_e.
  163.  
  164.           For XXXXSSSSGGGGIIIIvvvvccccQQQQuuuueeeerrrryyyyMMMMoooonnnniiiittttoooorrrrBBBBaaaasssseeeePPPPrrrroooottttooooccccoooollll, see the discussion in
  165.           DESCRIPTION.
  166.  
  167.  
  168.      SSSSEEEEEEEE AAAALLLLSSSSOOOO
  169.           XSGIvc
  170.  
  171.  
  172.  
  173.  
  174.  
  175.  
  176.  
  177.  
  178.  
  179.  
  180.  
  181.  
  182.  
  183.  
  184.  
  185.  
  186.  
  187.  
  188.  
  189.  
  190.  
  191.  
  192.  
  193.  
  194.  
  195.      Page 3                                          (printed 10/3/02)
  196.  
  197.  
  198.  
  199.