home *** CD-ROM | disk | FTP | other *** search
/ Amiga ISO Collection / AmigaUtilCD1.iso / FileMover / HF-OM1.DMS / in.adf / OpusSDK.lha / SDK / docs / clipboard.doc < prev    next >
Encoding:
Text File  |  1996-08-28  |  2.5 KB  |  102 lines
  1. dopus5.library/CloseClipBoard                   dopus5.library/CloseClipBoard
  2.  
  3.     NAME
  4.         CloseClipBoard - close a clipboard handle
  5.  
  6.     SYNOPSIS
  7.         CloseClipBoard(handle)
  8.                          A0
  9.  
  10.         void CloseClipBoard(APTR);
  11.  
  12.     FUNCTION
  13.         Closes a handle to the clipboard opened with OpenClipBoard().
  14.  
  15.     INPUTS
  16.         handle - clipboard handle
  17.  
  18.     RESULT
  19.         The clipboard unit is closed.
  20.  
  21.     SEE ALSO
  22.         OpenClipBoard()
  23.  
  24. dopus5.library/OpenClipBoard                     dopus5.library/OpenClipBoard
  25.  
  26.     NAME
  27.         OpenClipBoard - open clipboard for easy access
  28.  
  29.     SYNOPSIS
  30.         OpenClipBoard(unit)
  31.                        D0
  32.  
  33.         APTR OpenClipBoard(ULONG);
  34.  
  35.     FUNCTION
  36.         This function opens a specified unit of the clipboard.device. Used
  37.         with the other clipboard functions, it provides an easy method to
  38.         manipulate text strings with the clipboard.
  39.  
  40.     INPUTS
  41.         unit - unit number to open (usually 0)
  42.  
  43.     RESULT
  44.         Returns clipboard handle.
  45.  
  46.     SEE ALSO
  47.         CloseClipBoard()
  48.  
  49. dopus5.library/ReadClipString                   dopus5.library/ReadClipString
  50.  
  51.     NAME
  52.         ReadClipString - read a text string from the clipboard
  53.  
  54.     SYNOPSIS
  55.         ReadClipString(handle, buffer, size)
  56.                          A0      A1     D0
  57.  
  58.         long ReadClipString(APTR, char *, long);
  59.  
  60.     FUNCTION
  61.         This function reads a string of text from the clipboard handle.
  62.  
  63.     INPUTS
  64.         handle - clipboard handle
  65.         buffer - buffer to store string
  66.         size - size of buffer
  67.  
  68.     RESULT
  69.         Returns the length of the string. If there was no valid FTXT string
  70.         in the clipboard, it returns 0.
  71.  
  72.     SEE ALSO
  73.         OpenClipBoard(), WriteClipString()
  74.  
  75. dopus5.library/WriteClipString                 dopus5.library/WriteClipString
  76.  
  77.     NAME
  78.         WriteClipString - write a text string to the clipboard
  79.  
  80.     SYNOPSIS
  81.         WriteClipString(handle, buffer, size)
  82.                           A0      A1     D0
  83.  
  84.         BOOL WriteClipString(APTR, char *, long);
  85.  
  86.     FUNCTION
  87.         This function writes a string of text to the clipboard handle.
  88.  
  89.     INPUTS
  90.         handle - clipboard handle
  91.         buffer - buffer containing string
  92.         size - length of string
  93.  
  94.     RESULT
  95.         Returns TRUE if it succeeded, FALSE otherwise. The string is stored
  96.         in standard FTXT format, readable by ReadClipString() and most
  97.         other programs that access the clipboard.
  98.  
  99.     SEE ALSO
  100.         OpenClipBoard(), ReadClipString()
  101.  
  102.