Returns the CICA Code as a String for the given enumeration value. This is the value that will appear in the CICA document.

Namespace:  BargeEx
Assembly:  BargeEx (in BargeEx.dll)
Version: 3.0.400.140 (3.0.400.140)

Syntax

C#
public static string GetCicaCode(
	Enum value
)
Visual Basic (Declaration)
Public Shared Function GetCicaCode ( _
	value As Enum _
) As String
Visual C++
public:
static String^ GetCicaCode(
	Enum^ value
)

Parameters

value
Type: System..::.Enum
The enumeration value who's CICA Code will be returned.

Return Value

The CICA Code for the given enumeration value.

Remarks

This value may differ from the value returned by the ToString function.

Examples

The following example converts the CicaDocumentErrorCode.ReferentialIntegrity value to its CICA Code equivalent ("RI").
CopyVisual Basic
Dim CicaCode As String

' Convert Enum to CICA Code
CicaCode = BargeEx.Utilities.GetCicaCode(BargeEx.CicaDocumentErrorCode.ReferentialIntegrity)
CopyC#
String CicaCode;

// Convert Enum to CICA Code
CicaCode = BargeEx.Utilities.GetCicaCode(BargeEx.CicaDocumentErrorCode.ReferentialIntegrity);

Exceptions

ExceptionCondition
System..::.ArgumentNullException The value of the value parameter is a null reference (Nothing in Visual Basic).

See Also