FieldDirection Enum

Reference

Definition

Namespace:: System.CodeDom

Assembly:: System.CodeDom.dll

Assembly:: System.dll

Package:: System.CodeDom v9.0.0

Source:: FieldDirection.cs

Source:: FieldDirection.cs

Source:: FieldDirection.cs

Source:: FieldDirection.cs

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

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

public enum class FieldDirection

public enum FieldDirection

[System.Runtime.InteropServices.ComVisible(true)]
[System.Serializable]
public enum FieldDirection

type FieldDirection =

[<System.Runtime.InteropServices.ComVisible(true)>]
[<System.Serializable>]
type FieldDirection =

Public Enum FieldDirection

Inheritance: Object

ValueType

Enum
FieldDirection

Attributes: ComVisibleAttribute SerializableAttribute

Fields

Name	Value	Description
In	0	An incoming field.
Out	1	An outgoing field.
Ref	2	A field by reference.

Examples

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 = 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) {
//        }

// 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;
method1.Parameters.Add(param1);

// Declares a Int32 parameter passed by incoming field.
CodeParameterDeclarationExpression param2 = new 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) {
//        }

           ' 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

Remarks

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

Applies to

Jaa