ObjectParameter Class

Reference

Definition

Namespace:: System.Data.Objects

Assembly:: System.Data.Entity.dll

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.

Represents a query parameter that is passed to an object query.

public ref class ObjectParameter sealed

public sealed class ObjectParameter

type ObjectParameter = class

Public NotInheritable Class ObjectParameter

Inheritance: Object
ObjectParameter

Examples

This example adds new parameters to the collection. It iterates through the ObjectParameterCollection and displays the name, type, and value of each parameter in the collection.

using (AdventureWorksEntities context =
    new AdventureWorksEntities())
{
    string queryString =
        @"SELECT VALUE contact FROM AdventureWorksEntities.Contacts
        AS contact WHERE contact.LastName = @ln
        AND contact.FirstName = @fn";

    ObjectQuery<Contact> contactQuery =
        new ObjectQuery<Contact>(queryString, context);

    // Add parameters to the collection.
    contactQuery.Parameters.Add(new ObjectParameter("ln", "Adams"));
    contactQuery.Parameters.Add(new ObjectParameter("fn", "Frances"));

    ObjectParameterCollection objectParameterCollection =
        contactQuery.Parameters;

    // Iterate through the ObjectParameterCollection.
    foreach (ObjectParameter result in objectParameterCollection)
    {
        Console.WriteLine("{0} {1} {2}", result.Name,
            result.Value,
            result.ParameterType);
    }
}

Remarks

Represents a query parameter that is passed to an ObjectQuery<T> or a query builder method. For more information, see Query Builder Methods.

Object parameters consist of a name, a type, and a value.

This class cannot be inherited. For more information, see ObjectParameterCollection.

Constructors

ObjectParameter(String, Object)	Initializes a new instance of the ObjectParameter class with the specified name and value.
ObjectParameter(String, Type)	Initializes a new instance of the ObjectParameter class with the specified name and type.

Properties

Name	Gets the parameter name, which can only be set through a constructor.
ParameterType	Gets the parameter type.
Value	Gets or sets the parameter value.

Methods

Equals(Object)	Determines whether the specified object is equal to the current object. (Inherited from Object)
GetHashCode()	Serves as the default hash function. (Inherited from Object)
GetType()	Gets the Type of the current instance. (Inherited from Object)
MemberwiseClone()	Creates a shallow copy of the current Object. (Inherited from Object)
ToString()	Returns a string that represents the current object. (Inherited from Object)

Applies to

Dela via