GetField Method (String, BindingFlags)

Article
01/16/2013

[This documentation is for preview only, and is subject to change in later releases. Blank topics are included as placeholders.]

Searches for the specified field, using the specified binding constraints.

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

Syntax

'Declaration
Public MustOverride Function GetField ( _
    name As String, _
    bindingAttr As BindingFlags _
) As FieldInfo

public abstract FieldInfo GetField(
    string name,
    BindingFlags bindingAttr
)

public:
virtual FieldInfo^ GetField(
    String^ name, 
    BindingFlags bindingAttr
) abstract

abstract GetField : 
        name:string * 
        bindingAttr:BindingFlags -> FieldInfo

public abstract function GetField(
    name : String, 
    bindingAttr : BindingFlags
) : FieldInfo

Parameters

name
Type: System. . :: . .String
The string containing the name of the data field to get.

bindingAttr
Type: System.Reflection. . :: . .BindingFlags
A bitmask comprised of one or more BindingFlags that specify how the search is conducted.
-or-
Zero, to return nullNothingnullptrunita null reference (Nothing in Visual Basic).

Return Value

Type: System.Reflection. . :: . .FieldInfo
An object representing the field that matches the specified requirements, if found; otherwise, nullNothingnullptrunita null reference (Nothing in Visual Basic).

Implements

IReflect. . :: . .GetField(String, BindingFlags)

Remarks

The following table shows what members of a base class are returned by the Get methods when reflecting on a type.

Member Type	Static	Non-Static
Constructor	No	No
Field	No	Yes. A field is always hide-by-name-and-signature.
Event	Not applicable	The common type system rule is that the inheritance is the same as that of the methods that implement the property. Reflection treats properties as hide-by-name-and-signature. See note 2 below.
Method	No	Yes. A method (both virtual and non-virtual) can be hide-by-name or hide-by-name-and-signature.
Nested Type	No	No
Property	Not applicable	The common type system rule is that the inheritance is the same as that of the methods that implement the property. Reflection treats properties as hide-by-name-and-signature. See note 2 below.

Hide-by-name-and-signature considers all of the parts of the signature, including custom modifiers, return types, parameter types, sentinels, and unmanaged calling conventions. This is a binary comparison.
For reflection, properties and events are hide-by-name-and-signature. If you have a property with both a get and a set accessor in the base class, but the derived class has only a get accessor, the derived class property hides the base class property, and you will not be able to access the setter on the base class.
Custom attributes are not part of the common type system.

The following BindingFlags filter flags can be used to define which fields to include in the search:

You must specify either BindingFlags.Instance or BindingFlags.Static in order to get a return.
Specify BindingFlags.Public to include public fields in the search.
Specify BindingFlags.NonPublic to include non-public fields (that is, private, internal, and protected fields) in the search.
Specify BindingFlags.FlattenHierarchy to include public and protected static members up the hierarchy; private static members in inherited classes are not included.

The following BindingFlags modifier flags can be used to change how the search works:

BindingFlags.IgnoreCase to ignore the case of name.
BindingFlags.DeclaredOnly to search only the fields declared on the Type, not fields that were simply inherited.

See System.Reflection..::..BindingFlags for more information.

If the current Type represents a constructed generic type, this method returns the FieldInfo with the type parameters replaced by the appropriate type arguments.

If the current Type represents a type parameter in the definition of a generic type or generic method, this method searches the fields of the class constraint.

.NET Framework Security

Full trust for the immediate caller. This member cannot be used by partially trusted code. For more information, see dd66cd4c-b087-415f-9c3e-94e3a1835f74.

Share via