RecordId (Record function): Difference between revisions
Jump to navigation
Jump to search
(Automatically generated page update) |
No edit summary |
||
| (3 intermediate revisions by the same user not shown) | |||
| Line 1: | Line 1: | ||
{{Template:Record:RecordId subtitle}} | {{Template:Record:RecordId subtitle}} | ||
Get the <var class="product">Imagine Transparency</var> recordId for the <var>Record</var> object. | |||
==Syntax== | ==Syntax== | ||
{{Template:Record:RecordId syntax}} | {{Template:Record:RecordId syntax}} | ||
===Syntax terms=== | ===Syntax terms=== | ||
<table class="syntaxTable"> | <table class="syntaxTable"> | ||
<tr><th>%string</th><td>string</td></tr> | <tr><th>%string</th><td>The recordId of the record on <var class="product">Imagine</var> if the record is in a file that is an <var class="product">Imagine Transparency</var> file, or an empty string, otherwise.</td></tr> | ||
<tr><th>record</th> | <tr><th>record</th> | ||
<td><var>Record</var> object</td></tr> | <td><var>Record</var> object</td></tr> | ||
</table> | </table> | ||
==Usage notes== | ==Usage notes== | ||
<p> | |||
The recordId for <var class="product">Imagine</var> associated records is an 8-byte binary string value. This can be used to create another <var>Record</var> object with the [[NewFromRecordId (Record function)|NewFromRecordId]] function though there is really no good reason to create another <var>Record</var> object this way, or it could be passed to the <var class="product">Imagine</var> broker, probably after converting it to hex. Note, however, that while recordIds uniquely identify any record in <var class="product">Imagine</var>, <var class="product">Imagine</var> still needs to know the <var class="product">Imagine</var> file that holds the record to locate it. This can be obtained using the [[ImagineFile (Record function)|ImagineFile]] method. | |||
</p> | |||
==Examples== | ==Examples== | ||
==See also== | ==See also== | ||
{{Template:Record:RecordId footer}} | {{Template:Record:RecordId footer}} | ||
Latest revision as of 21:28, 28 March 2025
Return the recordId of the Imagine Transparency record (Record class)
Get the Imagine Transparency recordId for the Record object.
Syntax
%string = record:RecordId
Syntax terms
| %string | The recordId of the record on Imagine if the record is in a file that is an Imagine Transparency file, or an empty string, otherwise. |
|---|---|
| record | Record object |
Usage notes
The recordId for Imagine associated records is an 8-byte binary string value. This can be used to create another Record object with the NewFromRecordId function though there is really no good reason to create another Record object this way, or it could be passed to the Imagine broker, probably after converting it to hex. Note, however, that while recordIds uniquely identify any record in Imagine, Imagine still needs to know the Imagine file that holds the record to locate it. This can be obtained using the ImagineFile method.