FieldDirection Enumeration

.NET Framework (current version)

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

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

Syntax

[SerializableAttribute]
[ComVisibleAttribute(true)]
public enum class FieldDirection

Members

	Member name	Description
	In	An incoming field.
	Out	An outgoing field.
	Ref	A field by reference.

Remarks

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

Examples

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

C++

// Declares a method.
CodeMemberMethod^ method1 = gcnew CodeMemberMethod;
method1->Name = "TestMethod";

// Declares a string parameter passed by reference.
CodeParameterDeclarationExpression^ param1 = gcnew CodeParameterDeclarationExpression( "System.String","stringParam" );
param1->Direction = FieldDirection::Ref;
method1->Parameters->Add( param1 );

// Declares a Int32 parameter passed by incoming field.
CodeParameterDeclarationExpression^ param2 = gcnew CodeParameterDeclarationExpression( "System.Int32","intParam" );
param2->Direction = FieldDirection::Out;
method1->Parameters->Add( param2 );

// A C# code generator produces the following source code for the preceeding example code:
//        private void TestMethod(ref string stringParam, out int intParam) {
//        }

Version Information

.NET Framework
Available since 1.1