ObjectContext.ExecuteFunction メソッド

定義

名前空間:

System.Data.Objects

アセンブリ:

System.Data.Entity.dll

オーバーロード

ExecuteFunction(String, ObjectParameter[])	データ ソースで定義され、概念モデルで表現されるストアド プロシージャまたは関数を実行します。関数から返される結果は破棄され、実行によって影響を受けた行の数が返されます。
ExecuteFunction<TElement>(String, ObjectParameter[])	データ ソースで定義され、概念モデルにマップされたストアド プロシージャまたは関数を、パラメーターを指定して実行します。 型指定された ObjectResult<T> を返します。
ExecuteFunction<TElement>(String, MergeOption, ObjectParameter[])	データ ソースで定義され、概念モデルで表現される指定のストアド プロシージャまたは関数を、パラメーターとマージ オプションを指定して実行します。 型指定された ObjectResult<T> を返します。

ExecuteFunction(String, ObjectParameter[])

データ ソースで定義され、概念モデルで表現されるストアド プロシージャまたは関数を実行します。関数から返される結果は破棄され、実行によって影響を受けた行の数が返されます。

public:
 int ExecuteFunction(System::String ^ functionName, ... cli::array <System::Data::Objects::ObjectParameter ^> ^ parameters);

public int ExecuteFunction (string functionName, params System.Data.Objects.ObjectParameter[] parameters);

member this.ExecuteFunction : string * System.Data.Objects.ObjectParameter[] -> int

Public Function ExecuteFunction (functionName As String, ParamArray parameters As ObjectParameter()) As Integer

パラメーター

functionName

String

ストアド プロシージャまたは関数の名前。 名前には、 などの <Container Name>.<Function Name>コンテナー名を含めることができます。 既定のコンテナー名がわかっている場合は、関数名のみが必要です。

parameters

ObjectParameter[]

ObjectParameter オブジェクトの配列。

戻り値

Int32

影響を受けた行の数。

例外

ArgumentException

function が null または空です。

- または -

function が見つかりません。

InvalidOperationException

エンティティ リーダーは、この function をサポートしていません。

- または -

リーダーと function で型が一致していません。

ExecuteFunction<TElement>(String, ObjectParameter[])

データ ソースで定義され、概念モデルにマップされたストアド プロシージャまたは関数を、パラメーターを指定して実行します。 型指定された ObjectResult<T> を返します。

public:
generic <typename TElement>
 System::Data::Objects::ObjectResult<TElement> ^ ExecuteFunction(System::String ^ functionName, ... cli::array <System::Data::Objects::ObjectParameter ^> ^ parameters);

public System.Data.Objects.ObjectResult<TElement> ExecuteFunction<TElement> (string functionName, params System.Data.Objects.ObjectParameter[] parameters);

member this.ExecuteFunction : string * System.Data.Objects.ObjectParameter[] -> System.Data.Objects.ObjectResult<'Element>

Public Function ExecuteFunction(Of TElement) (functionName As String, ParamArray parameters As ObjectParameter()) As ObjectResult(Of TElement)

型パラメーター

TElement

データ ソースに対して関数が実行されたときに返された ObjectResult<T> のエンティティ型。 この型は、IEntityWithChangeTracker を実装している必要があります。

パラメーター

functionName

String

ストアド プロシージャまたは関数の名前。 名前には、 などの <Container Name>.<Function Name>コンテナー名を含めることができます。 既定のコンテナー名がわかっている場合は、関数名のみが必要です。

parameters

ObjectParameter[]

ObjectParameter オブジェクトの配列。

戻り値

ObjectResult<TElement>

ストアド プロシージャによって返されるデータの ObjectResult<T>。

例外

ArgumentException

function が null または空です。

- または -

function が見つかりません。

InvalidOperationException

エンティティ リーダーは、この function をサポートしていません。

- または -

リーダーと function で型が一致していません。

注釈

メソッドは ExecuteFunction 、データ ソースで定義され、概念モデルで表されるストアド プロシージャまたは関数を実行するために使用されるヘルパー メソッドです。 Entity Data Model ツールは、概念モデルの FunctionImport 要素 ごとにメソッドを生成します。 これらのメソッドは、厳密に型指定された ExecuteFunction を呼び出して、型指定された ObjectResult<T>を返します。 詳細については、「 ストアド プロシージャを使用したアプリケーション コード (Entity Framework)」を参照してください。

パラメーター配列には関数のすべてのパラメーターが必要であり、関数自体の型を含め、すべての型がインポート関数のメタデータに対してチェックされます。 null 値は CLR 値型に対して許可されます。 パラメーターの検証がプロバイダーによって実行されます。

メソッドは ExecuteFunction のAppendOnly値をMergeOption使用します。 したがって、オブジェクトがオブジェクト コンテキストに既に存在する場合、データ ソースからは読み込まれません。

こちらもご覧ください

• オブジェクトの使用 (Entity Framework)

ExecuteFunction<TElement>(String, MergeOption, ObjectParameter[])

データ ソースで定義され、概念モデルで表現される指定のストアド プロシージャまたは関数を、パラメーターとマージ オプションを指定して実行します。 型指定された ObjectResult<T> を返します。

public:
generic <typename TElement>
 System::Data::Objects::ObjectResult<TElement> ^ ExecuteFunction(System::String ^ functionName, System::Data::Objects::MergeOption mergeOption, ... cli::array <System::Data::Objects::ObjectParameter ^> ^ parameters);

public System.Data.Objects.ObjectResult<TElement> ExecuteFunction<TElement> (string functionName, System.Data.Objects.MergeOption mergeOption, params System.Data.Objects.ObjectParameter[] parameters);

member this.ExecuteFunction : string * System.Data.Objects.MergeOption * System.Data.Objects.ObjectParameter[] -> System.Data.Objects.ObjectResult<'Element>

Public Function ExecuteFunction(Of TElement) (functionName As String, mergeOption As MergeOption, ParamArray parameters As ObjectParameter()) As ObjectResult(Of TElement)

型パラメーター

TElement

データ ソースに対して関数が実行されたときに返された ObjectResult<T> のエンティティ型。 この型は、IEntityWithChangeTracker を実装している必要があります。

パラメーター

functionName

String

ストアド プロシージャまたは関数の名前。 名前には、 などの <Container Name>.<Function Name>コンテナー名を含めることができます。 既定のコンテナー名がわかっている場合は、関数名のみが必要です。

mergeOption

MergeOption

クエリの実行時に使用する MergeOption。

parameters

ObjectParameter[]

ObjectParameter オブジェクトの配列。

戻り値

ObjectResult<TElement>

ストアド プロシージャによって返されるデータの ObjectResult<T>。

例外

ArgumentException

function が null または空です。

- または -

function が見つかりません。

InvalidOperationException

エンティティ リーダーは、この function をサポートしていません。

- または -

リーダーと function で型が一致していません。

注釈

メソッドは ExecuteFunction 、データ ソースで定義され、概念モデルで表されるストアド プロシージャまたは関数を実行するために使用されるヘルパー メソッドです。 Entity Data Model ツールは、概念モデルの FunctionImport 要素 ごとにメソッドを生成します。 これらのメソッドは、厳密に型指定された ExecuteFunction を呼び出して、型指定された ObjectResult<T>を返します。 詳細については、「 ストアド プロシージャを使用したアプリケーション コード (Entity Framework)」を参照してください。

パラメーター配列には関数のすべてのパラメーターが必要であり、関数自体の型を含め、すべての型がインポート関数のメタデータに対してチェックされます。 null 値は CLR 値型に対して許可されます。 パラメーターの検証がプロバイダーによって実行されます。

こちらもご覧ください

• オブジェクトの使用 (Entity Framework)