Export (0) Print
Expand All
Expand Minimize
This topic has not yet been rated - Rate this topic

FieldDirection Enumeration

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

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

[SerializableAttribute] 
[ComVisibleAttribute(true)] 
public enum FieldDirection
/** @attribute SerializableAttribute() */ 
/** @attribute ComVisibleAttribute(true) */ 
public enum FieldDirection
SerializableAttribute 
ComVisibleAttribute(true) 
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;
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.
CodeMemberMethod method1 = new CodeMemberMethod();
method1.set_Name("TestMethod");
// Declares a string parameter passed by reference.
CodeParameterDeclarationExpression param1 = new 
    CodeParameterDeclarationExpression("System.String", "stringParam");
param1.set_Direction(FieldDirection.Ref);
method1.get_Parameters().Add(param1);
// Declares a Int32 parameter passed by incoming field.
CodeParameterDeclarationExpression param2 = new 
    CodeParameterDeclarationExpression("System.Int32", "intParam");
param2.set_Direction(FieldDirection.Out);
method1.get_Parameters().Add(param2);
// A VJ# code generator produces the following source code for 
// the preceeding example code:
//    private void TestMethod(/** @ref */ String stringParam,
//        /** @ref */  int intParam)
//    {
//    } //TestMethod

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

The Microsoft .NET Framework 3.0 is supported on Windows Vista, Microsoft Windows XP SP2, and Windows Server 2003 SP1.

.NET Framework

Supported in: 3.0, 2.0, 1.1, 1.0
Did you find this helpful?
(1500 characters remaining)
Thank you for your feedback

Community Additions

ADD
Show:
© 2014 Microsoft. All rights reserved.