Use Enumerated Values with Bit Flags to Handle Multiple Options
If your code uses a set of options and you don't use enumerated values, you can end up writing opaque code like this which passes an unexplained "magic number" to a method:
cust.Update(1)
With enumerated values, your code becomes easier to read because you can pass a named value:
cust.Update(UpdateOptions.Deferred)
Some applications need a set of options that can be combined in a variety of ways. In that scenario, a favorite developers' trick is to have each bit in a Byte represent one of the options. By using values that are powers of 2 and logical Ors, a developer can set individual bits in the Byte; using those same values against the Byte, along with logical Ands, a developer can check which bits in a Byte are set. Bringing in enumerated values makes working with bit flags easier to both read and write.
First, you need to override the default integer values for enumerated values to set the enumerated values to powers of 2, as in this enumeration:
<Flags>
Public Enum UpdateOptions
Deferred = 1
Audited = 2
Transacted = 4
End Enum
To use these enumerated values with the Update method to specify both the Deferred and Audited options, you would Or together the enumerated values. The Visual Basic code looks like this (in C#, you would use the | operator instead of the Or):
cust.Update(UpdateOptions.Deferred Or UpdateOptions.Audited)
Inside the Update method, to accept the Byte created by Oring together the options and to see if a particular option has been set, you use this code in Visual Basic (in C#, use the & operator instead of And):
Private Sub Update(Options As Byte)
If Options And UpdateOptions.Deferred Then
You don't need the Flags attribute I put on my enumeration, but it does simplify debugging. The Flags attribute causes the ToString method to generate a useful result when used on a Byte that's been cast to the type of the enumeration. This example casts the Options variable to my UpdateOptions type, and then calls the result's ToString method:
Private Sub Update(Options As Byte)
Debug.WriteLine(CType(Options, UpdateOptions).ToString())
Because I used the Flags attribute on the UpdateOptions enumeration, the output is the informative "Deferred, Audited"; without the Flags attribute, the output would have been the less helpful "3".
Posted by Peter Vogel on 05/07/2013