| GEOS SDK TechDocs | | ChunkArraySort() ... | ClipboardQueryItem() ...

---

ClipboardClearQuickTransferNotification()

void	ClipboardClearQuickTransferNotification(
        optr	notificationOD);

This routine removes an object or process from quick-transfer notification. It is typically used in the object's MSG_META_DETACH handler or in the Process object's MSG_GEN_PROCESS_CLOSE_APPLICATION to ensure that it is not notified after it has already detached.

Pass the optr of the object specified to receive notification in ClipboardStartQuickTransfer() (or the geode handle if a process).

Note that an object may also want to check if a quick-transfer is in progress when detaching and possibly abort it if there is one.

Include: clipbrd.goh

ClipboardDoneWithItem()

void	ClipboardDoneWithItem(
        TransferBlockID header);

This routine is called when an object or Process is done using a transfer item. It relinquishes exclusive access to the item's transfer VM file after the caller had previously called ClipboardQueryItem() .

Include: clipbrd.goh

ClipboardEndQuickTransfer()

void	ClipboardEndQuickTransfer(
        ClipboardQuickNotifyFlags 				flags);

This routine ends a quick-transfer operation by resetting the pointer image, clearing any quick-transfer region, clearing the quick-transfer item, and sending out any needed notification of the completed transfer.

Pass this routine a record of ClipboardQuickNotifyFlags . Pass the value CQNF_MOVE if the operation was completed and was a move; pass CQNF_COPY if the operation was completed and was a copy. If the operation could not be completed (e.g. incompatible data types), pass CQNF_NO_OPERATION or CQNF_ERROR.

The notification sent out by the UI will be in the form of the message MSG_META_CLIPBOARD_NOTIFY_QUICK_TRANSFER_CONCLUDED . This message notifies the originator of the transfer item of the type of operation; the originator can then respond if necessary.

Include: clipbrd.goh

ClipboardEnumItemFormats()

word	ClipboardEnumItemFormats(
        TransferBlockID 		header,
        word 		maxNumFormats,
        ClipboardFormatID *		buffer);

This routine returns a list of all the formats supported by the current transfer item. To see whether a particular format is supported, you can use ClipboardTestItemFormat() instead.

Pass this routine the following:

header

The transfer item header as returned by ClipboardQueryItem() .

maxNumFormats

The maximum number of formats that should be returned. You should set your return buffer (see below) large enough to support this size.

buffer

A pointer to a locked or fixed buffer into which the formats will be copied. Upon return, the buffer will contain the proper number of ClipboardFormatID structures, one for each format available. This buffer should be at least large enough to support the number of formats requested in maxNumFormats .

The word return value is the total number of formats returned. This number will be equal to or less than the number passed in maxNumFormats . The routine will also return the passed buffer filled with that number of ClipboardFormatID structures.

Include: clipbrd.goh

See Also: ClipboardTestItemFormat().

ClipboardGetClipboardFile()

VMFileHandle ClipboardGetClipboardFile(void);

This routine returns the VM file handle of the current default transfer VM file.

Include: clipbrd.goh

ClipboardGetItemInfo()

optr	ClipboardGetItemInfo(
        TransferBlockID header);

This routine returns the source identifier (CIH _sourceID ) of the current transfer item. Pass the transfer item's header returned by ClipboardQueryItem() .

Include: clipbrd.goh

ClipboardGetNormalItemInfo()

TransferBlockID ClipboardGetNormalItemInfo(void);

This routine returns information about the normal transfer item. It returns a TransferBlockID dword which contains the VM file handle of the transfer file and the VM block handle of the transfer item's header block.

To extract the file handle from the return value, use the macro FileFromTransferBlockID() . To extract the block handle, use the macro BlockFromTransferBlockID() .

Include: clipbrd.goh

ClipboardGetQuickItemInfo()

TransferBlockID ClipboardGetQuickItemInfo(void);

This routine returns information about the quick-transfer transfer item. It returns a TransferBlockID dword which contains the VM file handle of the transfer file and the VM block handle of the transfer item's header block.

To extract the file handle from the return value, use the macro FileFromTransferBlockID() . To extract the block handle, use the macro BlockFromTransferBlockID() .

Include: clipbrd.goh

ClipboardGetQuickTransferStatus()

Boolean	ClipboardGetQuickTransferStatus(void);

This routine returns true if a quick-transfer operation is in progress, false otherwise. It is often called when objects or Processes are shutting down in order to abort any quick-transfers originated by the caller.

Include: clipbrd.goh

ClipboardGetUndoItemInfo()

TransferBlockID ClipboardGetUndoItemInfo(void);

This routine returns information about the undo transfer item. It returns a TransferBlockID dword which contains the VM file handle of the transfer file and the VM block handle of the transfer item's header block.

To extract the file handle from the return value, use the macro FileFromTransferBlockID() . To extract the block handle, use the macro BlockFromTransferBlockID() .

Include: clipbrd.goh