MaxItemLength (Stringlist property): Difference between revisions
Jump to navigation
Jump to search
m (1 revision) |
m (syntax digram, tags and links) |
||
| Line 1: | Line 1: | ||
{{Template:Stringlist:MaxItemLength subtitle}} | {{Template:Stringlist:MaxItemLength subtitle}} | ||
Under <var class=product>Sirius Mods</var> Version 6.5, this method returns the maximum <var> | Under <var class="product">Sirius Mods</var> Version 6.5, this method returns the maximum <var>stringlist</var> item length. Under <var class="product">Sirius Mods</var> Version 6.6, this method returns the part of a <var>stringlist</var> item that is on the first CCATEMP page of the item. While items can be considerably longer than this (up to 2**31-1 bytes), this limit still affects some methods. For example, the <var>[[Locate (Stringlist function)|Locate]]</var> and <var>[[LocateUp (Stringlist function)|LocateUp]]</var> will not search beyond the <var>MaxItemLength</var> column in a <var>stringlist</var> item. | ||
<var>MaxItemLength</var> accepts no arguments, and it returns the maximum length of a <var> | <var>MaxItemLength</var> accepts no arguments, and it returns the maximum length of a <var>stringlist</var> item (currently 6124) or that part of a <var>stringlist</var> item that is on the first CCATEMP page of the item. | ||
==Syntax== | ==Syntax== | ||
| Line 10: | Line 10: | ||
<table class="syntaxTable"> | <table class="syntaxTable"> | ||
<tr><th>%max</th> | <tr><th>%max</th> | ||
<td>A numeric variable set to the maximum length of a <var> | <td>A numeric variable set to the maximum length of a <var>stringlist</var> item. </td></tr> | ||
<tr><th>(<var>Stringlist</var></th> | <tr><th>%(<var>Stringlist</var>)</th> | ||
<td>The class name in parentheses denotes a shared method. <var>MaxItemLength</var> can also be invoked via a <var> | <td>The class name in parentheses denotes a shared method. <var>MaxItemLength</var> can also be invoked via a <var>stringlist</var> object variable, which may be null.</td></tr> | ||
</table> | </table> | ||
==Usage notes== | ==Usage notes== | ||
<ul> | <ul> | ||
<li><var>MaxItemLength</var>'s chief purpose is to avoid having code with a constant (like 6124) whose value is subject to change. Under <var class=product>Sirius Mods</var> Version 6.5, 6124 was the maximum length of a <var> | <li><var>MaxItemLength</var>'s chief purpose is to avoid having code with a constant (like 6124) whose value is subject to change. Under <var class="product">Sirius Mods</var> Version 6.5, 6124 was the maximum length of a <var>stringlist</var> item. Under <var class="product">Sirius Mods</var> Version 6.6 and later, some methods such as <var>[[Locate (Stringlist function)|Locate]]</var> and <var>[[LocateUp (Stringlist function)|LocateUp]]</var> still only operate on the first 6124 bytes of <var>stringlist</var> items.<li>While Sirius Software is not likely to reduce this value, because of the complex backward compatibility issues, it might someday increase it, as it eliminated the <var>stringlist</var> item length limit in <var class="product">Sirius Mods</var> 6.6. | ||
</ul> | </ul> | ||
[[Category:Stringlist methods|MaxItemLength property]] | [[Category:Stringlist methods|MaxItemLength property]] | ||
Revision as of 08:20, 26 January 2011
Maximum Stringlist item length (Stringlist class)
Under Sirius Mods Version 6.5, this method returns the maximum stringlist item length. Under Sirius Mods Version 6.6, this method returns the part of a stringlist item that is on the first CCATEMP page of the item. While items can be considerably longer than this (up to 2**31-1 bytes), this limit still affects some methods. For example, the Locate and LocateUp will not search beyond the MaxItemLength column in a stringlist item.
MaxItemLength accepts no arguments, and it returns the maximum length of a stringlist item (currently 6124) or that part of a stringlist item that is on the first CCATEMP page of the item.
Syntax
%max = %(Stringlist):MaxItemLength
Syntax terms
| %max | A numeric variable set to the maximum length of a stringlist item. |
|---|---|
| %(Stringlist) | The class name in parentheses denotes a shared method. MaxItemLength can also be invoked via a stringlist object variable, which may be null. |
Usage notes
- MaxItemLength's chief purpose is to avoid having code with a constant (like 6124) whose value is subject to change. Under Sirius Mods Version 6.5, 6124 was the maximum length of a stringlist item. Under Sirius Mods Version 6.6 and later, some methods such as Locate and LocateUp still only operate on the first 6124 bytes of stringlist items.
- While Sirius Software is not likely to reduce this value, because of the complex backward compatibility issues, it might someday increase it, as it eliminated the stringlist item length limit in Sirius Mods 6.6.