XmClipboardRegisterFormat(3X)

NAME
     XmClipboardRegisterFormat  --A clipboard function that registers a new for-
     mat

SYNOPSIS
     #include <Xm/Xm.h>
     #include <Xm/CutPaste.h>

     int XmClipboardRegisterFormat (display, format_name, format_length)
          Display     * display;
          char        * format_name;
          int         format_length;


VERSION
     This page documents version 1.2 of the Motif library.

DESCRIPTION
     XmClipboardRegisterFormat registers a new format.  Each  format  stored  on
     the  clipboard should have a length associated with it; this length must be
     known to the clipboard routines.  Formats are known as targets in  the  In-
     ter-Client  Communication  Conventions  Manual (ICCCM).  All of the formats
     specified by the ICCCM conventions are  preregistered.   Any  other  format
     that  the  application  wants to use must either be 8-bit data or be regis-
     tered via this routine.  Failure to register the length of the data results
     in incompatible applications across platforms having  different  byte-swap-
     ping orders.


     display        Specifies  a  pointer  to the Display structure that was re-
                    turned in a previous call to XOpenDisplay or XtDisplay.

     format_name    Specifies the string name for the new format (target).

     format_length  Specifies the format length in bits (8, 16, or 32).


RETURN VALUE
     ClipboardBadFormat
                    The format_name must not be NULL, and the format_length must
                    be 8, 16, or 32.

     ClipboardSuccess
                    The function is successful.

     ClipboardLockedThe function failed because the clipboard was locked by  an-
                    other application.  The application can continue to call the
                    function  again with the same parameters until the lock goes
                    away.  This gives the application the opportunity to ask  if
                    the  user  wants  to keep trying or to give up on the opera-
                    tion.

     ClipboardFail  The function failed because the format  was  already  regis-
                    tered with this length.


RELATED INFORMATION
     XmClipboardStartCopy(3X).

                                                   XmClipboardRegisterFormat(3X)