MaxItemLength (Stringlist property): Difference between revisions
Jump to navigation
Jump to search
m (→Usage notes) |
m (minor cleanup) |
||
| (2 intermediate revisions by 2 users not shown) | |||
| Line 1: | Line 1: | ||
{{Template:Stringlist:MaxItemLength subtitle}} | {{Template:Stringlist:MaxItemLength subtitle}} | ||
This method returns the maximum length of 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 and LocateUp (Stringlist functions)|Locate]]</var> and <var>[[Locate and LocateUp (Stringlist functions)|LocateUp]]</var> functions do not search beyond the <var>MaxItemLength</var> column in a <var>Stringlist</var> item. | |||
==Syntax== | ==Syntax== | ||
{{Template:Stringlist:MaxItemLength syntax}} | {{Template:Stringlist:MaxItemLength syntax}} | ||
===Syntax terms=== | ===Syntax terms=== | ||
<table | <table> | ||
<tr><th>%max</th> | <tr><th>%max</th> | ||
<td>A numeric variable | <td>A numeric variable to contain the maximum length (currently 6124) of that part of a <var>Stringlist</var> item that is on the first CCATEMP page of the item.</td></tr> | ||
<tr><th><var>%(Stringlist)</var></th> | |||
<tr><th><var class="nobr">%(Stringlist)</var></th> | |||
<td>The class name in parentheses denotes a [[Notation conventions for methods#Shared methods|shared]] method. <var>MaxItemLength</var> can also be invoked via a <var>Stringlist</var> object variable, which may be null.</td></tr> | <td>The class name in parentheses denotes a [[Notation conventions for methods#Shared methods|shared]] method. <var>MaxItemLength</var> can also be invoked via a <var>Stringlist</var> object variable, which may be null.</td></tr> | ||
</table> | </table> | ||
| Line 17: | Line 17: | ||
==Usage notes== | ==Usage notes== | ||
<ul> | <ul> | ||
<li><var>MaxItemLength's</var> chief purpose is to avoid having code with a constant (like 6124) whose value is subject to change. | <li><var>MaxItemLength's</var> chief purpose is to avoid having code with a constant (like 6124) whose value is subject to change. Formerly, 6124 was the maximum length of a <var>Stringlist</var> item. Some methods, such as <var>Locate</var> and <var>LocateUp</var>, still only operate on the first 6124 bytes of <var>Stringlist</var> items. While Rocket Software is not likely to reduce this value, because of the complex backward compatibility issues, it might someday increase it. | ||
</ul> | </ul> | ||
==See also== | ==See also== | ||
{{Template:Stringlist:MaxItemLength footer}} | {{Template:Stringlist:MaxItemLength footer}} | ||
Latest revision as of 15:57, 15 April 2016
Maximum Stringlist item length (Stringlist class)
This method returns the maximum length of 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 functions do not search beyond the MaxItemLength column in a Stringlist item.
Syntax
%max = %(Stringlist):MaxItemLength
Syntax terms
| %max | A numeric variable to contain the maximum length (currently 6124) of that part of a Stringlist item that is on the first CCATEMP page of the 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. Formerly, 6124 was the maximum length of a Stringlist item. Some methods, such as Locate and LocateUp, still only operate on the first 6124 bytes of Stringlist items. While Rocket Software is not likely to reduce this value, because of the complex backward compatibility issues, it might someday increase it.