Changes between Initial Version and Version 1 of Docs/Prog/Manual/ApplicationLibraries/lib825ev/Weight/FormatTareWt

Timestamp:

08/20/10 10:08:02 (14 years ago)

Author:

Don Wilson

Comment:

--

Docs/Prog/Manual/ApplicationLibraries/lib825ev/Weight/FormatTareWt

@@ +1 @@
+= FormatTareWt =
+Format a string representation of the tare weight
+
+{{{
+string FormatTareWt(int nScale, int nLen = 7);
+
+char* FormatTareWt(int nScale, char* pszBuffer, int nLen = 7);
+}}}
+
+== Parameters == 
+
+ * nScale - scale number
+ * pszBuffer - character array to write result into. Must be long enough to hold the string and null terminator.
+ * nLen - length to format the string, spaces will be padded to the left.
+
+== Return Value ==
+
+ * Returns the string formatted tare weight.
+
+== Remarks ==
+
+This will format the raw tare weight into appropriate divisions and add zeros for zero weight if necessary based on the interval. For example, for interval of 20 lb is specified and the weight is zero the output will be "   00".
+
+== Examples ==
+
+{{{
+string strWt = FormatTareWt(1);
+DisplayText(0, 0, strWt);
+}}}
+
+{{{
+char szWt[20];
+FormatTareWt(1, szWt);
+DisplayText(0, 0, szWt);
+}}}
+
+== See Also ==
+
+ * FormatGrossWt
+ * FormatNetWt
+ * FormatWt
+