FieldDirection Enumeration

 
System_CAPS_noteNote

The .NET API Reference documentation has a new home. Visit the .NET API Browser on docs.microsoft.com to see the new experience.

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

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

<SerializableAttribute>
<ComVisibleAttribute(True)>
Public Enumeration FieldDirection

Member nameDescription
In

An incoming field.

Out

An outgoing field.

Ref

A 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

.NET Framework
Available since 1.1
Return to top
Show: