The Clipboard: 2.2 Transfer Data Structures: ClipboardItemFormatInfo

Up: GEOS SDK TechDocs | Up | Prev: 2.1 The Transfer VM File Format | Next: 2.3 Transfer Data Structures

This structure contains information about a specific format of the transfer item. The Transfer VM File will support up to ten formats of a given item at once (for both the Clipboard and quick-transfer); each of these formats is stored in its own VM block or VM chain and is represented in the header by a ClipboardItemFormatInfo structure in the array CIH_formats .

The ClipboardItemFormatInfo structure contains other information about the specific format as well as space for two extra words of data. The structure is shown in ClipboardItemFormatInfo .

Each element in the CIH_formats array contains two items: One word represents the manufacturer ID of the geode responsible for the format (useful if a custom format is used within several applications from a single manufacturer), and the other represents the actual format number. To combine these words into a ClipboardItemFormatID record, or to extract either word from the record, use the macros shown after ClipboardItemFormatInfo .

Code Display 7-2 ClipboardItemFormatInfo

/* The ClipboardItemFormatInfo structure contains information about a given
 * format of the transfer item. */
typedef struct {
		/* CIFI_format contains a format ID as well as the
		 * manufacturer ID of the geode responsible for the format. */
	ClipboardItemFormatID	 		CIFI_format;
		/* CIFI_extra1 and CIFI_extra2 are extra words provided for
		 * format-specific use. */
	word		CIFI_extra1;
	word		CIFI_extra2;
		/* CIFI_vmChain is a VM handle pointing to the first block in the
		 * specific format. */
	VMChain		CIFI_vmChain;
		/* CIFI_renderer contains the token of the geode that created
		 * the format. */
	GeodeToken		CIFI_renderer;
} ClipboardItemFormatInfo ;

Up: GEOS SDK TechDocs | Up | Prev: 2.1 The Transfer VM File Format | Next: 2.3 Transfer Data Structures