LCMS2IT8MBS.Constructor(context as LCMS2ContextMBS = nil)

Type	Topic	Plugin	Version	macOS	Windows	Linux	iOS	Targets
method	LCMS2	MBS Images Plugin	12.4	✅ Yes	✅ Yes	✅ Yes	✅ Yes	All

Allocates an empty CGATS.17 object.

LCMS2IT8MBS.DefineDblFormat(Formatter as string)

Type	Topic	Plugin	Version	macOS	Windows	Linux	iOS	Targets
method	LCMS2	MBS Images Plugin	12.4	✅ Yes	✅ Yes	✅ Yes	✅ Yes	All

Sets the format string for float numbers.

It uses the "C" sprintf convention. The default format string is "%.10g".

LCMS2IT8MBS.EnumDataFormat as string()

Type	Topic	Plugin	Version	macOS	Windows	Linux	iOS	Targets
method	LCMS2	MBS Images Plugin	12.4	✅ Yes	✅ Yes	✅ Yes	✅ Yes	All

Returns an array with pointers to the column names in current table.

Return the column names in table.

Some examples using this method:

• /Images/LCMS2/IT8 Reader

LCMS2IT8MBS.EnumProperties as string()

Type	Topic	Plugin	Version	macOS	Windows	Linux	iOS	Targets
method	LCMS2	MBS Images Plugin	12.4	✅ Yes	✅ Yes	✅ Yes	✅ Yes	All

Enumerates all properties in current table.

Returns array of property name string.

Some examples using this method:

• /Images/LCMS2/IT8 Reader

LCMS2IT8MBS.EnumPropertyMulti(Prop as string) as string()

Type	Topic	Plugin	Version	macOS	Windows	Linux	iOS	Targets
method	LCMS2	MBS Images Plugin	12.4	✅ Yes	✅ Yes	✅ Yes	✅ Yes	All

Enumerates all the identifiers found in a multi‐value property in current table.

Prop: A string holding property name
Returns an array with property names.

LCMS2IT8MBS.FindDataFormat(Sample as string) as Integer

Type	Topic	Plugin	Version	macOS	Windows	Linux	iOS	Targets
method	LCMS2	MBS Images Plugin	12.4	✅ Yes	✅ Yes	✅ Yes	✅ Yes	All

Returns the position (column) of a given data sample name in current table.

First column is 0 (SAMPLE_ID).
Returns column number if found, ‐1 if not found

LCMS2IT8MBS.GetData(Patch as string, Sample as string) as string

Type	Topic	Plugin	Version	macOS	Windows	Linux	iOS	Targets
method	LCMS2	MBS Images Plugin	12.4	✅ Yes	✅ Yes	✅ Yes	✅ Yes	All

Gets a cell [Patch, Sample] as a literal string (uncooked string) in current table.

Patch: The intended patch name (row)
Sample: The intended sample name (column)

Returns the data for the intended cell on success, "" on error.

LCMS2IT8MBS.GetDataAsDouble(Patch as string, Sample as string) as Double

Type	Topic	Plugin	Version	macOS	Windows	Linux	iOS	Targets
method	LCMS2	MBS Images Plugin	12.4	✅ Yes	✅ Yes	✅ Yes	✅ Yes	All

Gets a cell [Patch, Sample] as a double in current table.

Patch: The intended patch name (row)
Sample: The intended sample name (column)

Returns the data for the intended cell interpreted as Double on success, 0 on error.

LCMS2IT8MBS.GetDataRowCol(Row as Integer, Col as Integer) as string

Type	Topic	Plugin	Version	macOS	Windows	Linux	iOS	Targets
method	LCMS2	MBS Images Plugin	12.4	✅ Yes	✅ Yes	✅ Yes	✅ Yes	All

Gets a cell [row, col] as a literal string in current table.

This function is fast since it has not to search columns or rows by name.

row, col: The position of the cell.

Returns the data for the intended cell on success, "" on error.

Some examples using this method:

• /Images/LCMS2/IT8 Reader

LCMS2IT8MBS.GetDataRowColAsDouble(Row as Integer, Col as Integer) as Double

Type	Topic	Plugin	Version	macOS	Windows	Linux	iOS	Targets
method	LCMS2	MBS Images Plugin	12.4	✅ Yes	✅ Yes	✅ Yes	✅ Yes	All

Gets a cell [row, col] as a double in current table.

This function is fast since it has not to search columns or rows by name.
row, col: The position of the cell.

Returns the data for the intended cell interpreted as Double on success, 0 on error.

LCMS2IT8MBS.GetPatchByName(Patch as string) as Integer

Type	Topic	Plugin	Version	macOS	Windows	Linux	iOS	Targets
method	LCMS2	MBS Images Plugin	12.4	✅ Yes	✅ Yes	✅ Yes	✅ Yes	All

Lookups patch index by name.

LCMS2IT8MBS.GetPatchName(nPatch as Integer) as string

Type	Topic	Plugin	Version	macOS	Windows	Linux	iOS	Targets
method	LCMS2	MBS Images Plugin	12.4	✅ Yes	✅ Yes	✅ Yes	✅ Yes	All

Fills buffer with the contents of SAMPLE_ID column for the set given in nPatch.

That usually corresponds to patch name. Buffer may be NULL to get the internal memory block used by the CGATS.17 object. If specified, buffer gets a copy of such block. In this case it should have space for at least 1024 characters.

nPatch: set number to retrieve name

Returns the patch name. "" if error.

Some examples using this method:

• /Images/LCMS2/IT8 Reader

LCMS2IT8MBS.GetProperty(Prop as string) as string

Type	Topic	Plugin	Version	macOS	Windows	Linux	iOS	Targets
method	LCMS2	MBS Images Plugin	12.4	✅ Yes	✅ Yes	✅ Yes	✅ Yes	All

Gets a property as a literal string in current table.

Prop: A string holding property name.

Returns the data for the intended property on success, "" on error.

LCMS2IT8MBS.GetPropertyAsDouble(Prop as string) as Double

Type	Topic	Plugin	Version	macOS	Windows	Linux	iOS	Targets
method	LCMS2	MBS Images Plugin	12.4	✅ Yes	✅ Yes	✅ Yes	✅ Yes	All

Gets a property as a double in current table.

Prop: A string holding property name.

Returns the data for the intended property interpreted as Double on success, 0 on error.

Some examples using this method:

• /Images/LCMS2/IT8 Reader

LCMS2IT8MBS.GetPropertyMulti(Key as string, SubKey as string) as string

Type	Topic	Plugin	Version	macOS	Windows	Linux	iOS	Targets
method	LCMS2	MBS Images Plugin	12.4	✅ Yes	✅ Yes	✅ Yes	✅ Yes	All

Queries property.

LCMS2IT8MBS.GetSheetType as string

Type	Topic	Plugin	Version	macOS	Windows	Linux	iOS	Targets
method	LCMS2	MBS Images Plugin	12.4	✅ Yes	✅ Yes	✅ Yes	✅ Yes	All

This function returns the type of the IT8 object.

LCMS2IT8MBS.HeaderIsDictionary(HeaderName as string) as boolean

Type	Topic	Plugin	Version	macOS	Windows	Linux	iOS	Targets
method	LCMS2	MBS Images Plugin	13.1	✅ Yes	✅ Yes	✅ Yes	✅ Yes	All

Checks if a header entry has subkeys, so it has a dictionary with keys and values.

This is a helper method in our plugin. May stop working if the internals of LCMS2 change in an update.

LCMS2IT8MBS.HeaderList as string()

Type	Topic	Plugin	Version	macOS	Windows	Linux	iOS	Targets
method	LCMS2	MBS Images Plugin	13.1	✅ Yes	✅ Yes	✅ Yes	✅ Yes	All

Returns list of header properties.

This is a helper method in our plugin. May stop working if the internals of LCMS2 change in an update.

LCMS2IT8MBS.HeadersAsDictionary as dictionary

Type	Topic	Plugin	Version	macOS	Windows	Linux	iOS	Targets
method	LCMS2	MBS Images Plugin	13.1	✅ Yes	✅ Yes	✅ Yes	✅ Yes	All

Returns the header keys and values as dictionary.

This is a helper method in our plugin. May stop working if the internals of LCMS2 change in an update.
Returns nil on any error.

Some examples using this method:

• /Images/LCMS2/IT8 Reader

LCMS2IT8MBS.HeaderSubDictionary(HeaderName as string) as dictionary

Type	Topic	Plugin	Version	macOS	Windows	Linux	iOS	Targets
method	LCMS2	MBS Images Plugin	13.1	✅ Yes	✅ Yes	✅ Yes	✅ Yes	All

Queries the dictionary with subkeys for a given header entry.

This is a helper method in our plugin. May stop working if the internals of LCMS2 change in an update.
Returns nil on any error.

Some examples using this method:

• /Images/LCMS2/IT8 Reader

LCMS2IT8MBS.HeaderValue(HeaderName as string) as string

Type	Topic	Plugin	Version	macOS	Windows	Linux	iOS	Targets
method	LCMS2	MBS Images Plugin	13.1	✅ Yes	✅ Yes	✅ Yes	✅ Yes	All

Returns the header value for the given header.

This is a helper method in our plugin. May stop working if the internals of LCMS2 change in an update.

LCMS2IT8MBS.SaveToFile(file as folderitem) as boolean

Type	Topic	Plugin	Version	macOS	Windows	Linux	iOS	Targets
method	LCMS2	MBS Images Plugin	12.4	✅ Yes	✅ Yes	✅ Yes	✅ Yes	All

This function saves a CGATS.17 object to a file.

File: Destination file. Existing file will be overwritten if possible.

Returns true on success, false on error

LCMS2IT8MBS.SaveToMemory as Memoryblock

Type	Topic	Plugin	Version	macOS	Windows	Linux	iOS	Targets
method	LCMS2	MBS Images Plugin	12.4	✅ Yes	✅ Yes	✅ Yes	✅ Yes	All

This function saves a CGATS.17 object to a contiguous memory block.

LCMS2IT8MBS.SaveToString as string

Type	Topic	Plugin	Version	macOS	Windows	Linux	iOS	Targets
method	LCMS2	MBS Images Plugin	12.4	✅ Yes	✅ Yes	✅ Yes	✅ Yes	All

This function saves a CGATS.17 object to a contiguous memory block.

LCMS2IT8MBS.SetComment(comment as string) as boolean

Type	Topic	Plugin	Version	macOS	Windows	Linux	iOS	Targets
method	LCMS2	MBS Images Plugin	12.4	✅ Yes	✅ Yes	✅ Yes	✅ Yes	All

This function is intended to provide a way automated IT8 creators can embed comments into the file.

Comments have no effect, and its only purpose is to document any of the file meaning. On this function the calling order is important; as successive calls to SetComment do embed comments in the same order the function is being called.

Comment: The comment to inserted

Returns true on success, false on error.

LCMS2IT8MBS.SetData(Patch as string, Sample as string, Val as string) as boolean

Type	Topic	Plugin	Version	macOS	Windows	Linux	iOS	Targets
method	LCMS2	MBS Images Plugin	12.4	✅ Yes	✅ Yes	✅ Yes	✅ Yes	All

Sets a cell [Patch, Sample] as a literal string (uncooked string) in current table.

Patch: The intended patch name (row)
Sample: The intended sample name (column)
Val: The value to be set, as a literal

Returns true on success, false on error.

LCMS2IT8MBS.SetDataAsDouble(Patch as string, Sample as string, Val as Double) as boolean

Type	Topic	Plugin	Version	macOS	Windows	Linux	iOS	Targets
method	LCMS2	MBS Images Plugin	12.4	✅ Yes	✅ Yes	✅ Yes	✅ Yes	All

Sets a cell [Patch, Sample] as a double in current table.

Patch: The intended patch name (row)
Sample: The intended sample name (column)
Val: The value to be set, as a cmsFloat64Number

Returns true on success, false on error

LCMS2IT8MBS.SetDataFormat(n as Integer, Sample as String) as boolean

Type	Topic	Plugin	Version	macOS	Windows	Linux	iOS	Targets
method	LCMS2	MBS Images Plugin	12.4	✅ Yes	✅ Yes	✅ Yes	✅ Yes	All

Sets column names in current table.

First column is 0 (SAMPLE_ID). Special property NUMBER_OF_FIELDS must be set before calling this function.

n: Column to set name
Sample: Name of data

Returns true on success, false on error.

LCMS2IT8MBS.SetDataRowCol(Row as Integer, Col as Integer, Val as string) as boolean

Type	Topic	Plugin	Version	macOS	Windows	Linux	iOS	Targets
method	LCMS2	MBS Images Plugin	12.4	✅ Yes	✅ Yes	✅ Yes	✅ Yes	All

Sets a cell [row, col] as a literal string in current table.

This function is fast since it has not to search columns or rows by name.

row, col: The position of the cell.
Val: The value to be set, as a literal string.

Returns true on success, false on error.

LCMS2IT8MBS.SetDataRowColAsDouble(Row as Integer, Col as Integer, Val as Double) as boolean

Type	Topic	Plugin	Version	macOS	Windows	Linux	iOS	Targets
method	LCMS2	MBS Images Plugin	12.4	✅ Yes	✅ Yes	✅ Yes	✅ Yes	All

Sets a cell [Patch, Sample] as a double in current table.

This function is fast since it has not to search columns or rows by name.

row, col: The position of the cell.
Val: The value to be set, as a cmsFloat64Number

Returns true on success, false on error

LCMS2IT8MBS.SetIndexColumn(Sample as string) as boolean

Type	Topic	Plugin	Version	macOS	Windows	Linux	iOS	Targets
method	LCMS2	MBS Images Plugin	12.4	✅ Yes	✅ Yes	✅ Yes	✅ Yes	All

Sets the index column.

LCMS2IT8MBS.SetPropertyDouble(Prop as string, Value as Double) as boolean

Type	Topic	Plugin	Version	macOS	Windows	Linux	iOS	Targets
method	LCMS2	MBS Images Plugin	12.4	✅ Yes	✅ Yes	✅ Yes	✅ Yes	All

Sets a property as a double in current table.

Prop: A string holding property name.
Value: The data for the intended property as Double.

Returns true on success, false on error.

LCMS2IT8MBS.SetPropertyHex(Prop as string, Value as UInt32) as boolean

Type	Topic	Plugin	Version	macOS	Windows	Linux	iOS	Targets
method	LCMS2	MBS Images Plugin	12.4	✅ Yes	✅ Yes	✅ Yes	✅ Yes	All

Sets a property as an hexadecimal constant (appends 0x) in current table.

Prop: A string holding property name.
Value: The value to be set (32 bits max)

Returns true on success, false on error.

LCMS2IT8MBS.SetPropertyMulti(Key as string, SubKey as string, Value as string) as boolean

Type	Topic	Plugin	Version	macOS	Windows	Linux	iOS	Targets
method	LCMS2	MBS Images Plugin	12.4	✅ Yes	✅ Yes	✅ Yes	✅ Yes	All

Adds a new sub‐property to the property Key.

Value of buffer is interpreted literally.

Key: A string holding property name.
SubKey: A string holding the sub‐property name.
Buffer: A string holding the uncooked value of sub‐property.

Returns true on success, false on error.

LCMS2IT8MBS.SetPropertyString(Prop as string, Value as String) as boolean

Type	Topic	Plugin	Version	macOS	Windows	Linux	iOS	Targets
method	LCMS2	MBS Images Plugin	12.4	✅ Yes	✅ Yes	✅ Yes	✅ Yes	All

Sets a property as a literal string in current table.

The string is enclosed in quotes "".
Returns true on success, false on error.

LCMS2IT8MBS.SetPropertyUncooked(Prop as string, Value as Memoryblock) as boolean

Type	Topic	Plugin	Version	macOS	Windows	Linux	iOS	Targets
method	LCMS2	MBS Images Plugin	12.4	✅ Yes	✅ Yes	✅ Yes	✅ Yes	All

Sets a property with no interpretation in current table.

No quotes "" are added. No checking is performed, and it is up to the programmer to make sure the string is valid.
Special prefixes:
0b: Binary
0x : Hexadecimal

Parameters:
cProp: A string holding property name.
Buffer: A string holding the uncooked value to place in the CGATS file.

Returns true on success, false on error.

LCMS2IT8MBS.SetSheetType(type as string) as boolean

Type	Topic	Plugin	Version	macOS	Windows	Linux	iOS	Targets
method	LCMS2	MBS Images Plugin	12.4	✅ Yes	✅ Yes	✅ Yes	✅ Yes	All

This function sets the type of a CGATS.17 object to the new type.

Returns true on success, false on error.

LCMS2IT8MBS.SetTable(nTable as UInt32) as UInt32

Type	Topic	Plugin	Version	macOS	Windows	Linux	iOS	Targets
method	LCMS2	MBS Images Plugin	12.4	✅ Yes	✅ Yes	✅ Yes	✅ Yes	All

This function positions the IT8 object in a given table, identified by its position.

Setting nTable to Table Count + 1 does allocate a new empty table.
Returns the current table number on success, ‐1 on error.

Some examples using this method:

• /Images/LCMS2/IT8 Reader

LCMS2IT8MBS.SetTableByLabel(Set as string, Field as string, ExpectedType as string) as Integer

Type	Topic	Plugin	Version	macOS	Windows	Linux	iOS	Targets
method	LCMS2	MBS Images Plugin	12.4	✅ Yes	✅ Yes	✅ Yes	✅ Yes	All

Sets table by label.

LCMS2IT8MBS.TableCount as UInt32

Type	Topic	Plugin	Version	macOS	Windows	Linux	iOS	Targets
method	LCMS2	MBS Images Plugin	12.4	✅ Yes	✅ Yes	✅ Yes	✅ Yes	All

This function returns the number of tables found in the current CGATS object.

Returns the number of tables on success, 0 on error.

Some examples using this method:

• /Images/LCMS2/IT8 Reader

LCMS2IT8MBS.ValidKeywords as string()

Type	Topic	Plugin	Version	macOS	Windows	Linux	iOS	Targets
method	LCMS2	MBS Images Plugin	13.1	✅ Yes	✅ Yes	✅ Yes	✅ Yes	All

Returns list of valid keywords.

This is a helper method in our plugin. May stop working if the internals of LCMS2 change in an update.

Some examples using this method:

• /Images/LCMS2/IT8 Reader

LCMS2IT8MBS.ValidSampleIDs as string()

Type	Topic	Plugin	Version	macOS	Windows	Linux	iOS	Targets
method	LCMS2	MBS Images Plugin	13.1	✅ Yes	✅ Yes	✅ Yes	✅ Yes	All

Returns list of valid sample IDs.

This is a helper method in our plugin. May stop working if the internals of LCMS2 change in an update.

Some examples using this method:

• /Images/LCMS2/IT8 Reader