Platforms to show: All Mac Windows Linux Cross-Platform
Back to LCMS2IT8MBS class.
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.
Some examples using this method:
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 |
The items on this page are in the following plugins: MBS Images Plugin.