home *** CD-ROM | disk | FTP | other *** search
/ IRIX Base Documentation 2001 May / SGI IRIX Base Documentation 2001 May.iso / usr / share / catman / p_man / cato / Xm / XmClipboardInquireFormat.z / XmClipboardInquireFormat
Encoding:
Text File  |  1998-10-20  |  6.9 KB  |  133 lines
  1.  
  2.  
  3.  
  4.      XXXXmmmmCCCClllliiiippppbbbbooooaaaarrrrddddIIIInnnnqqqquuuuiiiirrrreeeeFFFFoooorrrrmmmmaaaatttt((((3333XXXXUUUU))))NNNNIIIIXXXX SSSSyyyysssstttteeeemmmmXXXXVVVVmmmmCCCClllliiiippppbbbbooooaaaarrrrddddIIIInnnnqqqquuuuiiiirrrreeeeFFFFoooorrrrmmmmaaaatttt((((3333XXXX))))
  5.  
  6.  
  7.  
  8.      NNNNAAAAMMMMEEEE
  9.           XXXXmmmmCCCClllliiiippppbbbbooooaaaarrrrddddIIIInnnnqqqquuuuiiiirrrreeeeFFFFoooorrrrmmmmaaaatttt - A clipboard function that returns
  10.           a specified format name
  11.  
  12.      SSSSYYYYNNNNOOOOPPPPSSSSIIIISSSS
  13.           ####iiiinnnncccclllluuuuddddeeee <<<<XXXXmmmm////XXXXmmmm....hhhh>>>>
  14.           ####iiiinnnncccclllluuuuddddeeee <<<<XXXXmmmm////CCCCuuuuttttPPPPaaaasssstttteeee....hhhh>>>>
  15.  
  16.           iiiinnnntttt XXXXmmmmCCCClllliiiippppbbbbooooaaaarrrrddddIIIInnnnqqqquuuuiiiirrrreeeeFFFFoooorrrrmmmmaaaatttt ((((_d_i_s_p_l_a_y, _w_i_n_d_o_w, _i_n_d_e_x, _f_o_r_m_a_t__n_a_m_e__b_u_f,
  17.                     _b_u_f_f_e_r__l_e_n, _c_o_p_i_e_d__l_e_n))))
  18.                DDDDiiiissssppppllllaaaayyyy    * _d_i_s_p_l_a_y;;;;
  19.                WWWWiiiinnnnddddoooowwww     _w_i_n_d_o_w;;;;
  20.                iiiinnnntttt        _i_n_d_e_x;;;;
  21.                XXXXttttPPPPooooiiiinnnntttteeeerrrr  _f_o_r_m_a_t__n_a_m_e__b_u_f;;;;
  22.                uuuunnnnssssiiiiggggnnnneeeedddd lllloooonnnngggg_b_u_f_f_e_r__l_e_n;;;;
  23.                uuuunnnnssssiiiiggggnnnneeeedddd lllloooonnnngggg* _c_o_p_i_e_d__l_e_n;;;;
  24.  
  25.  
  26.      VVVVEEEERRRRSSSSIIIIOOOONNNN
  27.           This page documents version 1.2 of the Motif library.
  28.  
  29.      DDDDEEEESSSSCCCCRRRRIIIIPPPPTTTTIIIIOOOONNNN
  30.           XXXXmmmmCCCClllliiiippppbbbbooooaaaarrrrddddIIIInnnnqqqquuuuiiiirrrreeeeFFFFoooorrrrmmmmaaaatttt returns a specified format name for
  31.           the data item in the clipboard.  If the name must be
  32.           truncated, the function returns a warning status.
  33.  
  34.  
  35.           _d_i_s_p_l_a_y      Specifies a pointer to the DDDDiiiissssppppllllaaaayyyy structure
  36.                        that was returned in a previous call to
  37.                        XXXXOOOOppppeeeennnnDDDDiiiissssppppllllaaaayyyy or XXXXttttDDDDiiiissssppppllllaaaayyyy.
  38.  
  39.           _w_i_n_d_o_w       Specifies a widget's window ID that relates the
  40.                        application window to the clipboard.  The
  41.                        widget's window ID can be obtained by using
  42.                        XXXXttttWWWWiiiinnnnddddoooowwww.  The same application instance should
  43.                        pass the same window ID to each of the
  44.                        clipboard functions that it calls.
  45.  
  46.           _i_n_d_e_x        Specifies which of the ordered format names to
  47.                        obtain.  If this index is greater than the
  48.                        number of formats for the data item, this
  49.                        function returns a zero in the _c_o_p_i_e_d__l_e_n
  50.                        argument.
  51.  
  52.           _f_o_r_m_a_t__n_a_m_e__b_u_f
  53.                        Specifies the buffer that receives the format
  54.                        name.
  55.  
  56.           _b_u_f_f_e_r__l_e_n   Specifies the number of bytes in the format
  57.                        name buffer.
  58.  
  59.           _c_o_p_i_e_d__l_e_n   Specifies the number of bytes in the string
  60.  
  61.  
  62.  
  63.      Page 1                                          (printed 4/30/98)
  64.  
  65.  
  66.  
  67.  
  68.  
  69.  
  70.      XXXXmmmmCCCClllliiiippppbbbbooooaaaarrrrddddIIIInnnnqqqquuuuiiiirrrreeeeFFFFoooorrrrmmmmaaaatttt((((3333XXXXUUUU))))NNNNIIIIXXXX SSSSyyyysssstttteeeemmmmXXXXVVVVmmmmCCCClllliiiippppbbbbooooaaaarrrrddddIIIInnnnqqqquuuuiiiirrrreeeeFFFFoooorrrrmmmmaaaatttt((((3333XXXX))))
  71.  
  72.  
  73.  
  74.                        copied to the buffer.  If this argument equals
  75.                        zero, there is no _n_t_h format for the data item.
  76.  
  77.  
  78.      RRRREEEETTTTUUUURRRRNNNN VVVVAAAALLLLUUUUEEEE
  79.           CCCClllliiiippppbbbbooooaaaarrrrddddSSSSuuuucccccccceeeessssssss
  80.                        The function is successful.
  81.  
  82.           CCCClllliiiippppbbbbooooaaaarrrrddddLLLLoooocccckkkkeeeedddd
  83.                        The function failed because the clipboard was
  84.                        locked by another application.  The application
  85.                        can continue to call the function again with
  86.                        the same parameters until the lock goes away.
  87.                        This gives the application the opportunity to
  88.                        ask if the user wants to keep trying or to give
  89.                        up on the operation.
  90.  
  91.           CCCClllliiiippppbbbbooooaaaarrrrddddTTTTrrrruuuunnnnccccaaaatttteeee
  92.                        The data returned is truncated because the user
  93.                        did not provide a buffer large enough to hold
  94.                        the data.
  95.  
  96.           CCCClllliiiippppbbbbooooaaaarrrrddddNNNNooooDDDDaaaattttaaaa
  97.                        The function could not find data on the
  98.                        clipboard corresponding to the format
  99.                        requested.  This could occur because the
  100.                        clipboard is empty; there is data on the
  101.                        clipboard but not in the requested format; or
  102.                        the data in the requested format was passed by
  103.                        name and is no longer available.
  104.  
  105.  
  106.      RRRREEEELLLLAAAATTTTEEEEDDDD IIIINNNNFFFFOOOORRRRMMMMAAAATTTTIIIIOOOONNNN
  107.           XXXXmmmmCCCClllliiiippppbbbbooooaaaarrrrddddSSSSttttaaaarrrrttttCCCCooooppppyyyy((((3333XXXX)))).
  108.  
  109.  
  110.  
  111.  
  112.  
  113.  
  114.  
  115.  
  116.  
  117.  
  118.  
  119.  
  120.  
  121.  
  122.  
  123.  
  124.  
  125.  
  126.  
  127.  
  128.  
  129.      Page 2                                          (printed 4/30/98)
  130.  
  131.  
  132.  
  133.