Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

HPCC-15684 DOCS:ESPArray needs max_count or max_count_var #11139

Merged
merged 2 commits into from May 14, 2018
Merged

HPCC-15684 DOCS:ESPArray needs max_count or max_count_var #11139

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
9769683
HPCC-15684 DOCS:ESPArray needs max_count or max_count_var
May 8, 2018
ecde351
HPCC-15684 DOCS:ESPArray needs max_count or max_count_var
May 11, 2018
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
9 changes: 8 additions & 1 deletion docs/EN_US/DynamicESDL/DESDL-Mods/ESDLESParray.xml
View file
Open in desktop
Expand Up @@ -9,6 +9,9 @@
</indexterm>A structure for unbounded arrays. Arrays support inheritance
and can be nested.</para>

<para>Either [max_count_var(k)] or [max_count_var(k)] is required for an
ESPArray when k&gt;1.</para>

<para><emphasis role="bold">Example:</emphasis></para>

<programlisting>
Expand All @@ -22,7 +25,7 @@
int Age;
};

ESParray&lt;ESPstruct NameBlock, Name&gt; Names;
ESParray [max_count(20)] &lt;ESPstruct NameBlock, Name&gt; Names;

</programlisting>

Expand All @@ -42,4 +45,8 @@
&lt;Age&gt;33&lt;/Age&gt;
&lt;/Name&gt;
&lt;/Names&gt;</programlisting></para>

<para>See Also: <link
linkend="ESDL_Attributes_max_count_var">max_count_var</link>, <link
linkend="ESDL_Attributes_max_count">max_count</link> </para>
</sect1>
18 changes: 18 additions & 0 deletions docs/EN_US/DynamicESDL/DESDL-Mods/ESDLmax_count.xml
View file
Open in desktop
@@ -0,0 +1,18 @@
<?xml version="1.0" encoding="utf-8"?>
<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
"http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd">
<sect1 id="ESDL_Attributes_max_count">
<title>max_count</title>

<para><indexterm>
<primary>max_count</primary>
</indexterm>The max_count attribute is used to specify the expected max
items in a dataset (ESParray).</para>

<para><emphasis role="bold">Example:</emphasis></para>

<programlisting>[max_count(20)] ESParray &lt;ESPstruct MYRecord, Record&gt; Records; </programlisting>

<para>See Also: <link linkend="ESParray">ESParray</link>, <link
linkend="ESDL_Attributes_max_count_var">max_count_var</link></para>
</sect1>
12 changes: 8 additions & 4 deletions docs/EN_US/DynamicESDL/DESDL-Mods/ESDLmax_count_var.xml
View file
Open in desktop
Expand Up @@ -6,13 +6,17 @@

<para><indexterm>
<primary>max_count_var</primary>
</indexterm>The max_count_var attribute is used to specify the expected
max items in a dataset (ESParray).</para>
</indexterm>The max_count_var attribute is used to specify a variable (an
ECL Attribute) containing the value of the expected max items in a dataset
(ESParray).</para>

<para><emphasis role="bold">Example:</emphasis></para>

<programlisting>[max_count_var("iesp.Constants.JD.MaxRecords")] ESParray &lt;ESPstruct MYRecord, Record&gt; Records; </programlisting>

<para>Roxie will define the constant iesp.Constants.JD.MaxRecords and change
it at will without affecting ESP.</para>
<para>The ECL developer defines the constant iesp.Constants.JD.MaxRecords
rather than hard coding the max count value in the ESDL. </para>

<para>See Also: <link linkend="ESParray">ESParray</link>, <link
linkend="ESDL_Attributes_max_count">max_count</link></para>
</sect1>
4 changes: 4 additions & 0 deletions docs/EN_US/DynamicESDL/ESDL_LangRef_Includer.xml
View file
Open in desktop
Expand Up @@ -196,6 +196,10 @@
xpointer="element(/1)"
xmlns:xi="http://www.w3.org/2001/XInclude" />

<xi:include href="DynamicESDL/DESDL-Mods/ESDLmax_count.xml"
xpointer="element(/1)"
xmlns:xi="http://www.w3.org/2001/XInclude" />

<xi:include href="DynamicESDL/DESDL-Mods/ESDLmax_count_var.xml"
xpointer="element(/1)"
xmlns:xi="http://www.w3.org/2001/XInclude" />
Expand Down