فهرست منبع

Merge pull request #11663 from JamesDeFabia/HPCC-20151LogMethods

HPCC-20151 Document std.system.log.getGlobalId() & std.system.log.getLocalId()

Reviewed-By: Anthony Fishbeck <anthony.fishbeck@lexisnexis.com>
Reviewed-By: Richard Chapman <rchapman@hpccsystems.com>
Richard Chapman 6 سال پیش
والد
کامیت
4f64c7a94a

+ 39 - 0
docs/EN_US/ECLStandardLibraryReference/SLR-Mods/getGlobalId.xml

@@ -0,0 +1,39 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!DOCTYPE sect1 PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
+"http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd">
+<sect1 id="getGlobalId">
+  <title>getGlobalId</title>
+
+  <para><emphasis role="bold">STD.System.Log.getGlobalId<indexterm>
+      <primary>STD.System.Log.getGlobalId</primary>
+    </indexterm> <indexterm>
+      <primary>System.Log.getGlobalId</primary>
+    </indexterm> <indexterm>
+      <primary>Log.getGlobalId</primary>
+    </indexterm> <indexterm>
+      <primary>getGlobalId</primary>
+    </indexterm>(</emphasis>) </para>
+
+  <informaltable colsep="1" frame="all" rowsep="1">
+    <tgroup cols="2">
+      <colspec colwidth="80.50pt" />
+
+      <colspec />
+
+      <tbody>
+        <row>
+          <entry>Return:</entry>
+
+          <entry>getGlobalId returns the Global Id</entry>
+        </row>
+      </tbody>
+    </tgroup>
+  </informaltable>
+
+  <para>The <emphasis role="bold">getGlobalId </emphasis>gets the Global Id
+  associated with the current query or workunit. Example:</para>
+
+  <programlisting format="linespecific">IMPORT STD;
+STD.System.Log.getGlobalId();    
+</programlisting>
+</sect1>

+ 39 - 0
docs/EN_US/ECLStandardLibraryReference/SLR-Mods/getLocalId.xml

@@ -0,0 +1,39 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!DOCTYPE sect1 PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
+"http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd">
+<sect1 id="getLocalId">
+  <title>getLocalId</title>
+
+  <para><emphasis role="bold">STD.System.Log.getLocalId<indexterm>
+      <primary>STD.System.Log.getLocalId</primary>
+    </indexterm> <indexterm>
+      <primary>System.Log.getLocalId</primary>
+    </indexterm> <indexterm>
+      <primary>Log.getLocalId</primary>
+    </indexterm> <indexterm>
+      <primary>getLocalId</primary>
+    </indexterm>(</emphasis>)</para>
+
+  <informaltable colsep="1" frame="all" rowsep="1">
+    <tgroup cols="2">
+      <colspec colwidth="80.50pt" />
+
+      <colspec />
+
+      <tbody>
+        <row>
+          <entry>Return:</entry>
+
+          <entry>getLocalId returns the Local Id</entry>
+        </row>
+      </tbody>
+    </tgroup>
+  </informaltable>
+
+  <para>The <emphasis role="bold">getLocalId </emphasis>gets the Local Id
+  associated with the current query or workunit. Example:</para>
+
+  <programlisting format="linespecific">IMPORT STD;
+STD.System.Log.getLocalId();    
+</programlisting>
+</sect1>

+ 7 - 0
docs/EN_US/ECLStandardLibraryReference/SLR-includer.xml

@@ -577,6 +577,13 @@
 
     <xi:include href="ECLStandardLibraryReference/SLR-Mods/addWorkunitError.xml"
                 xmlns:xi="http://www.w3.org/2001/XInclude" />
+
+    <xi:include href="ECLStandardLibraryReference/SLR-Mods/getGlobalId.xml"
+                xmlns:xi="http://www.w3.org/2001/XInclude" />
+
+    <xi:include href="ECLStandardLibraryReference/SLR-Mods/getLocalId.xml"
+                xmlns:xi="http://www.w3.org/2001/XInclude" />
+ 
   </chapter>
 
   <chapter id="Auditing">