Online Documentation - Statistics - FAQ - Plugin Parts (All, Dependencies) - Class hierarchy
New in Version 22.2 22.3 22.4 22.5 23.0 23.1 23.2 23.3 23.4 23.5 24.0 24.1
The list of the topics, classes, interfaces, controls, modules, global methods by category, global methods by name, screenshots, licenses and examples.
Platforms to show: All Mac Windows Linux Cross-Platform
Back to LCMS2IT8MBS class.
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 |
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 |
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 |
Return the column names in table.
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 |
Returns array of property name string.
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 |
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 |
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 |
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 |
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 |
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.
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 |
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 |
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 |
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.
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 |
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 |
Prop: A string holding property name.
Returns the data for the intended property interpreted as Double on success, 0 on error.
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 |
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 |
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 |
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 |
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 |
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.
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 |
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.
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 |
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 |
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 |
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 |
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 |
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 |
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 |
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 |
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 |
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 |
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 |
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 |
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 |
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 |
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 |
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 |
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 |
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 |
Setting nTable to Table Count + 1 does allocate a new empty table.
Returns the current table number on success, ‐1 on error.
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 |
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 |
Returns the number of tables on success, 0 on error.
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 |
This is a helper method in our plugin. May stop working if the internals of LCMS2 change in an update.
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 |
This is a helper method in our plugin. May stop working if the internals of LCMS2 change in an update.
The items on this page are in the following plugins: MBS Images Plugin.