WINCLIP(3)               libwin Reference              WINCLIP(3)


NAME
       winclip - libwin's clipboard functionality

SYNOPSIS
       #include <libwin.h>

       int win_clip_open (void);
       int win_clip_close (void);
       int win_clip_empty (void);

       long win_clip_getsize (int format);
       int  win_clip_getdata  (int  format,  char  *buffer,  long
       buffer_size);
       int  win_clip_setdata  (int  format,  char  *buffer,  long
       buffer_size);

       int win_clip_compact (int size);

DESCRIPTION
       win_clip_open(),   win_clip_close()  and  win_clip_empty()
       open, close and empty the clipboard respectively.

       win_clip_getsize() returns the number of bytes required to
       store  the contents of the clipboard in the specified for-
       mat. This can then be used to allocate a  buffer  for  use
       with  win_clip_getdata(), which copies the contents of the
       clipboard of the specified format in the specified buffer.

       win_clip_setdata() copies the data in the specified format
       into the clipboard. This function seems to fail  if  there
       is  already  data in the clipboard from a Windows program.
       If  the  data   must   go   into   the   clipboard,   call
       win_clip_empty before win_clip_setdata().

       All  these functions will fail if Winoldap is not present,
       or does not support clipboard access in a  DOS  box  (this
       can  be checked using win_winoldap_getversion() - see win-
       ver(3)).

       win_clip_compact() checks to see if there's  enough  space
       for  size  bytes  of data. It returns the size in bytes of
       the largest contiguous block in the clipboard.

RETURN VALUES
       All the functions return -1 on failure and 0 or greater on
       success.     win_clip_open()    returns   CLIP_OPENED   or
       CLIP_OPENED_ALREADY on success.

SEE ALSO
       libwin(7), winver(3)

BUGS
       These functions do not work on Windows NT, 2000 or XP.




libwin 0.1.5            22 September 2002                       1

Page created on Sun Sep 29 21:12:26 2002 by m2h.pl, a man page to HTML convertor.
m2h.pl Version 1.3.2, Copyright 1997-2002 by Richard Dawe <webmaster@phekda.org>