Added documentation for GetRCDouble, GetRCFloat, and GetRCInt64.

lsdev · Aug 22, 2013 · fcbba98 · fcbba98
1 parent cef283b
commit fcbba98
Show file tree

Hide file tree

Showing 11 changed files with 159 additions and 0 deletions.
diff --git a/sdk/docs/lsapi/GetRCBool.xml b/sdk/docs/lsapi/GetRCBool.xml
@@ -37,7 +37,10 @@
     <fn>GetRCBoolDef</fn>
     <fn>GetRCColor</fn>
     <fn>GetRCCoordinate</fn>
+	<fn>GetRCDouble</fn>
+	<fn>GetRCFloat</fn>
     <fn>GetRCInt</fn>
+    <fn>GetRCInt64</fn>
     <fn>GetRCLine</fn>
     <fn>GetRCString</fn>
   </see-also>

diff --git a/sdk/docs/lsapi/GetRCBoolDef.xml b/sdk/docs/lsapi/GetRCBoolDef.xml
@@ -35,7 +35,10 @@
     <fn>GetRCBool</fn>
     <fn>GetRCColor</fn>
     <fn>GetRCCoordinate</fn>
+	<fn>GetRCDouble</fn>
+	<fn>GetRCFloat</fn>
     <fn>GetRCInt</fn>
+    <fn>GetRCInt64</fn>
     <fn>GetRCLine</fn>
     <fn>GetRCString</fn>
   </see-also>

diff --git a/sdk/docs/lsapi/GetRCColor.xml b/sdk/docs/lsapi/GetRCColor.xml
@@ -35,7 +35,10 @@
     <fn>GetRCBool</fn>
     <fn>GetRCBoolDef</fn>
     <fn>GetRCCoordinate</fn>
+	<fn>GetRCDouble</fn>
+	<fn>GetRCFloat</fn>
     <fn>GetRCInt</fn>
+    <fn>GetRCInt64</fn>
     <fn>GetRCLine</fn>
     <fn>GetRCString</fn>
   </see-also>

diff --git a/sdk/docs/lsapi/GetRCCoordinate.xml b/sdk/docs/lsapi/GetRCCoordinate.xml
@@ -54,7 +54,10 @@
     <fn>GetRCBool</fn>
     <fn>GetRCBoolDef</fn>
     <fn>GetRCColor</fn>
+	<fn>GetRCDouble</fn>
+	<fn>GetRCFloat</fn>
     <fn>GetRCInt</fn>
+    <fn>GetRCInt64</fn>
     <fn>GetRCLine</fn>
     <fn>GetRCString</fn>
     <fn>ParseCoordinate</fn>

diff --git a/sdk/docs/lsapi/GetRCDouble.xml b/sdk/docs/lsapi/GetRCDouble.xml
@@ -0,0 +1,45 @@
+<?xml version="1.0"?>
+<?xml-stylesheet type="text/xsl" href="lsapi.xslt"?>
+
+<function>
+  <name>GetRCDouble</name>
+  <description>
+    Gets a double from the configuration database.
+  </description>
+  <parameters>
+    <parameter>
+      <name>pszKeyName</name>
+      <description>
+        Name of the key to retrieve.
+      </description>
+      <type>LPCTSTR</type>
+    </parameter>
+    <parameter>
+      <name>nDefault</name>
+      <description>
+        Default value to return if the key cannot be found in the
+        configuration database.
+      </description>
+      <type>DOUBLE</type>
+    </parameter>
+  </parameters>
+  <return>
+    <description>
+      If the key is found, the return value is the value from the
+      configuration database. If the key cannot be found, the return value is
+      the value of the <param>nDefault</param> parameter.
+    </description>
+    <type>DOUBLE</type>
+  </return>
+  <see-also>
+    <fn>GetRCBool</fn>
+    <fn>GetRCBoolDef</fn>
+    <fn>GetRCColor</fn>
+    <fn>GetRCCoordinate</fn>
+    <fn>GetRCFloat</fn>
+    <fn>GetRCInt</fn>
+    <fn>GetRCInt64</fn>
+    <fn>GetRCLine</fn>
+    <fn>GetRCString</fn>
+  </see-also>
+</function>
diff --git a/sdk/docs/lsapi/GetRCFloat.xml b/sdk/docs/lsapi/GetRCFloat.xml
@@ -0,0 +1,45 @@
+<?xml version="1.0"?>
+<?xml-stylesheet type="text/xsl" href="lsapi.xslt"?>
+
+<function>
+  <name>GetRCFloat</name>
+  <description>
+    Gets a float from the configuration database.
+  </description>
+  <parameters>
+    <parameter>
+      <name>pszKeyName</name>
+      <description>
+        Name of the key to retrieve.
+      </description>
+      <type>LPCTSTR</type>
+    </parameter>
+    <parameter>
+      <name>nDefault</name>
+      <description>
+        Default value to return if the key cannot be found in the
+        configuration database.
+      </description>
+      <type>FLOAT</type>
+    </parameter>
+  </parameters>
+  <return>
+    <description>
+      If the key is found, the return value is the value from the
+      configuration database. If the key cannot be found, the return value is
+      the value of the <param>nDefault</param> parameter.
+    </description>
+    <type>FLOAT</type>
+  </return>
+  <see-also>
+    <fn>GetRCBool</fn>
+    <fn>GetRCBoolDef</fn>
+    <fn>GetRCColor</fn>
+    <fn>GetRCCoordinate</fn>
+    <fn>GetRCDouble</fn>
+    <fn>GetRCInt</fn>
+    <fn>GetRCInt64</fn>
+    <fn>GetRCLine</fn>
+    <fn>GetRCString</fn>
+  </see-also>
+</function>
diff --git a/sdk/docs/lsapi/GetRCInt.xml b/sdk/docs/lsapi/GetRCInt.xml
@@ -36,6 +36,9 @@
     <fn>GetRCBoolDef</fn>
     <fn>GetRCColor</fn>
     <fn>GetRCCoordinate</fn>
+    <fn>GetRCDouble</fn>
+    <fn>GetRCFloat</fn>
+    <fn>GetRCInt64</fn>
     <fn>GetRCLine</fn>
     <fn>GetRCString</fn>
   </see-also>

diff --git a/sdk/docs/lsapi/GetRCInt64.xml b/sdk/docs/lsapi/GetRCInt64.xml
@@ -0,0 +1,45 @@
+<?xml version="1.0"?>
+<?xml-stylesheet type="text/xsl" href="lsapi.xslt"?>
+
+<function>
+  <name>GetRCInt</name>
+  <description>
+    Gets a 64bit integer from the configuration database.
+  </description>
+  <parameters>
+    <parameter>
+      <name>pszKeyName</name>
+      <description>
+        Name of the key to retrieve.
+      </description>
+      <type>LPCTSTR</type>
+    </parameter>
+    <parameter>
+      <name>nDefault</name>
+      <description>
+        Default value to return if the key cannot be found in the
+        configuration database.
+      </description>
+      <type>INT64</type>
+    </parameter>
+  </parameters>
+  <return>
+    <description>
+      If the key is found, the return value is the value from the
+      configuration database. If the key cannot be found, the return value is
+      the value of the <param>nDefault</param> parameter.
+    </description>
+    <type>INT64</type>
+  </return>
+  <see-also>
+    <fn>GetRCBool</fn>
+    <fn>GetRCBoolDef</fn>
+    <fn>GetRCColor</fn>
+    <fn>GetRCCoordinate</fn>
+    <fn>GetRCDouble</fn>
+    <fn>GetRCFloat</fn>
+    <fn>GetRCInt</fn>
+    <fn>GetRCLine</fn>
+    <fn>GetRCString</fn>
+  </see-also>
+</function>
diff --git a/sdk/docs/lsapi/GetRCLine.xml b/sdk/docs/lsapi/GetRCLine.xml
@@ -63,7 +63,10 @@
     <fn>GetRCBoolDef</fn>
     <fn>GetRCColor</fn>
     <fn>GetRCCoordinate</fn>
+	<fn>GetRCDouble</fn>
+	<fn>GetRCFloat</fn>
     <fn>GetRCInt</fn>
+    <fn>GetRCInt64</fn>
     <fn>GetRCString</fn>
   </see-also>
 </function>
diff --git a/sdk/docs/lsapi/GetRCString.xml b/sdk/docs/lsapi/GetRCString.xml
@@ -60,7 +60,10 @@
     <fn>GetRCBoolDef</fn>
     <fn>GetRCColor</fn>
     <fn>GetRCCoordinate</fn>
+	<fn>GetRCDouble</fn>
+	<fn>GetRCFloat</fn>
     <fn>GetRCInt</fn>
+    <fn>GetRCInt64</fn>
     <fn>GetRCLine</fn>
   </see-also>
 </function>
diff --git a/sdk/docs/lsapi/index.xml b/sdk/docs/lsapi/index.xml
@@ -20,7 +20,10 @@
       <link>GetRCBoolDef</link>
       <link>GetRCColor</link>
       <link>GetRCCoordinate</link>
+      <link>GetRCDouble</link>
+      <link>GetRCFloat</link>
       <link>GetRCInt</link>
+      <link>GetRCInt64</link>
       <link>GetRCLine</link>
       <link>GetRCString</link>
       <link>LCClose</link>