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)

public enum 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.
CodeMemberMethod method1 = new CodeMemberMethod();
method1.Name = "TestMethod";

// Declares a string parameter passed by reference.
CodeParameterDeclarationExpression param1 = new CodeParameterDeclarationExpression("System.String", "stringParam");
param1.Direction = FieldDirection.Ref;

// Declares a Int32 parameter passed by incoming field.
CodeParameterDeclarationExpression param2 = new CodeParameterDeclarationExpression("System.Int32", "intParam");
param2.Direction = FieldDirection.Out;

// A C# code generator produces the following source code for the preceeding example code:

//        private void TestMethod(ref string stringParam, out int intParam) {
//        }

.NET Framework

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

.NET Framework Client Profile

Supported in: 4, 3.5 SP1

Windows 7, Windows Vista SP1 or later, Windows XP SP3, Windows XP SP2 x64 Edition, Windows Server 2008 (Server Core not supported), Windows Server 2008 R2 (Server Core supported with SP1 or later), Windows Server 2003 SP2

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