This documentation is archived and is not being maintained.

FieldDirection Enumeration

Defines identifiers used to indicate the direction of parameter and argument declarations.

Namespace:  System.CodeDom
Assembly:  System (in System.dll)

'Declaration
<SerializableAttribute> _
<ComVisibleAttribute(True)> _
Public Enumeration FieldDirection
'Usage
Dim instance As FieldDirection

Member nameDescription
InAn incoming field.
OutAn outgoing field.
RefA field by reference.

FieldDirection allows for passing arguments to functions by reference, or using incoming or outgoing parameters.

The following example demonstrates use of FieldDirection to indicate the field direction types of the parameters of a method in a method declaration.

' Declares a method. 
Dim method1 As New CodeMemberMethod()
method1.Name = "TestMethod" 

' Declares a string parameter passed by reference. 
Dim param1 As New CodeParameterDeclarationExpression("System.String", "stringParam")
param1.Direction = FieldDirection.Ref
method1.Parameters.Add(param1)

' Declares a Int32 parameter passed by incoming field. 
Dim param2 As New CodeParameterDeclarationExpression("System.Int32", "intParam")
param2.Direction = FieldDirection.Out
method1.Parameters.Add(param2)

' A Visual Basic code generator produces the following source code for the preceeding example code: 

'	 Private Sub TestMethod(ByRef stringParam As String, ByRef intParam As Integer) 
'    End Sub

Windows 7, Windows Vista, Windows XP SP2, Windows XP Media Center Edition, Windows XP Professional x64 Edition, Windows XP Starter Edition, Windows Server 2008 R2, Windows Server 2008, Windows Server 2003, Windows Server 2000 SP4, Windows Millennium Edition, Windows 98

The .NET Framework and .NET Compact Framework do not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.

.NET Framework

Supported in: 3.5, 3.0, 2.0, 1.1, 1.0
Show: