Changes between Version 33 and Version 34 of MapGuideCodingStandards

Timestamp:

01/26/15 05:01:31 (10 years ago)

Author:

jng

Comment:

--

MapGuideCodingStandards

@@ -6 +6 @@
 
 ||'''Revision'''||'''Date'''||'''Author'''||'''Comment'''||
+||1.6.3||26 Jan, 2015||Jackie Ng||Added section about argument checking||
 ||1.6.2||9 Dec, 2012||Jackie Ng||More about C++ documentation||
 ||1.6.1||31 May, 2012||Jackie Ng||More about exception handling||
@@ -153 +154 @@
 
 Of course the same stack vs. heap thinking applies to non-ref-counted objects.
+
+== Argument Checking and Validation ==
+
+Where possible, avoid doing your own argument checking/validation and manually throwing exceptions for invalid method arguments and use one of the available macros to do this for you in {{{Foundation\System\Util.h}}}
+
+{{{
+CHECKNULL(pointer, methodname) //Check that pointer is not null. Throws MgNullReferenceException if null
+CHECKARGUMENTNULL(pointer, methodname) //Check that pointer is not null. Throws MgNullArgumentException if null
+CHECKARGUMENTEMPTYSTRING(stlstring, methodname) //Check that given std::basic_string<T> is not empty. Throws MgInvalidArgumentException if empty
+MG_CHECK_RANGE(value, min, max, methodname) //Check that given argument is within the specified range. Throws MgNullReferenceException if null
+}}}
+
+These macros will not only do the requisite checks, but also capture the name of the offending argument and use the correct error message
 
 == Threading Guidelines ==