Notes® Virtual Fields

Notes® recognizes a set of virtual fields -- fields which are interpreted differently by the Notes® connector than by other connectors. To use these virtual fields, either set the virtual code of the relevant fields to the Notes® connector virtual code (obtain the property LCTOKEN_CONNECTOR_CODE from a Notes® connection, and set that code into the properly names field using the LCField.SetVirtualCode method), or use one of the Notes® properties which adds a virtual field to the result set. The virtual fields supported by Notes® are described as follows:

Field Name	Corresponding Property	Data type	Stream Length (in bytes)
UNID	LoadUnid	Binary (BLOB)	16.00
NOTEID	LoadNoteid	Integer	N/A
REF	LoadRef	Binary (BLOB)	16.00
FILE	LoadFile	Binary (Text List)	variable (up to 64K)
MODIFIED	LoadModified	Datetime	N/A
LCXHIER	CopyHierarchy	Binary (BLOB)	8.00
LCXFILE	CopyFile	Binary (BLOB)	4.00
LCXSPEC	CopyCompSpecial	Binary (BLOB)	4.00

Descriptions may vary based on whether a document is being read (Fetch) or written (Insert or Update):

• UNID

  Read -- Read the UNID of the document.

  Write -- Set the document's UNID to the field value.

• NOTEID

  Read -- Read the NOTEID of the document.

  Write - Ignored

• REF

  Read -- Read the parent UNID of a response document.

  Write -- Make the document a response to the document whose UNID is in this field.

• FILE

  Read -- Retrieve all attachments from the document, writing the files to disk. This field is set to a text list containing the filenames of all the files from the document.

  Write -- Store each entry in the text list value as a file attachment to the document.

• MODIFIED

  Read -- Read the last modified timestamp from the document.

  Write -- Ignored

• LCXHIER

  This field is only relevant when the document is both read from and written to a Notes® connector. When written, the field contents stored during the read are used to access the source database and transfer the entire response hierarchy beneath the document into the target database. Note that the source result set must still be valid at the time the document is written.

• LCXFILE

  This field is only relevant when the document is both read from and written to a Notes® connector. When written, the field contents stored during the read are used to access the source database and transfer all file attachments directly from the source document to the target document. Since they are transferred directly without temporary storage on disk, this is more efficient than the FILE property for Notes® to Notes® transfers. The source document must be the most recently fetched document in the result set at the time the document is written.

• LCXSPEC

  This field is only relevant when the document is both read from and written to a Notes® connector. When written, the field contents stored during the read are used to access the source database and transfer specific document fields required to retain full document fidelity for doclinks and rich text fonts. Specifically the fields "$Links" and "$Fonts" are copied. The source document must be the most recently fetched document in the result set at the time the document is written.