Parameter クラス (Microsoft.Office.Server.ApplicationRegistry.Administration)

[アーティクル]
02/02/2010

各メソッドの in、inout、out および return パラメータを表します。

名前空間: Microsoft.Office.Server.ApplicationRegistry.Administration
アセンブリ: Microsoft.SharePoint.Portal (microsoft.sharepoint.portal.dll 内)

構文

'宣言
<SharePointPermissionAttribute(SecurityAction.InheritanceDemand, ObjectModel:=True)> _
<SharePointPermissionAttribute(SecurityAction.Demand, ObjectModel:=True)> _
Public Class Parameter
    Inherits AccessControlledMetadataObject
'使用
Dim instance As Parameter

[SharePointPermissionAttribute(SecurityAction.InheritanceDemand, ObjectModel=true)] 
[SharePointPermissionAttribute(SecurityAction.Demand, ObjectModel=true)] 
public class Parameter : AccessControlledMetadataObject

備考

Web メソッドが void を返す場合は、値が out パラメータに返されている可能性があります。out パラメータをメタデータ内の戻り値パラメータとして記述することが必要です。ビジネスデータカタログの戻り値パラメータは、ビジネスデータカタログがバックエンドアプリケーションから読み取る値です。パラメータには次のような情報が含まれます。

パラメータの方向 (In、Out、InOut、Return)。
メソッド署名内のパラメータの順序を表す番号。
パラメータが省略可能かどうか。
TypeReflector。Parameter オブジェクトには TypeReflector が含まれます。TypeReflector は、 TypeDescriptor によって示される構造にしたがって既定値が指定された Parameter オブジェクトのインスタンス化を行い、インスタンス化された Parameter オブジェクト内で型記述子が参照する個々のフィールドの値を取得または設定します。

Web メソッドでは、パラメータ名は、ビジネスデータカタログで使用されるトークンです。パラメータ名は所定のメソッドに固有でなければなりませんが、名前は自由に付けることができます。ただし、TypeDescriptor 名は、バックエンドアプリケーションメソッドから返される構造およびフィールドと厳密に一致していなければなりません。

データベースの場合、パラメータ名はストアドプロシージャまたは SQL クエリのパラメータ名と完全に一致する必要があります。

例

次のコード例は、AdventureWorks2000 データベースの ProductModel エンティティ用の、メソッドインスタンス、フィルタ記述子、既定値、および型記述子を完備したメソッドを作成する方法を示しています。

Prerequisites

共有サービスプロバイダが既に作成されていることを確認します。
「[方法] 管理オブジェクトモデルを使用して LobSystem を作成する」に示すように、LobSystem インスタンスを作成して接続パラメータを設定します。
「[方法] 管理オブジェクトモデルを使用してエンティティを作成する」に示すように、ProductModel エンティティを作成します。
コード内の定数値 EnterYourSSPNameHere を共有リソースプロバイダの名前に置き換えます。

Project References

このサンプルを実行する前に、コンソールアプリケーションコードプロジェクトに以下のプロジェクト参照を追加します。

Microsoft.SharePoint
Microsoft.SharePoint.Portal
Microsoft.Office.Server

using System;
using System.Collections.Generic;
using System.Text;
using Microsoft.Office.Server.ApplicationRegistry.Administration;
using Microsoft.Office.Server.ApplicationRegistry.Infrastructure;
using WSSAdmin = Microsoft.SharePoint.Administration;
using OSSAdmin = Microsoft.Office.Server.Administration;

namespace Microsoft.SDK.SharePointServer.Samples
{
    class GetStartedAndCreateSystem
    {
        const string yourSSPName ="EnterYourSSPNameHere";

        static void Main(string[] args)
        {
            SetupBDC();
            CreateFinderMethod();
            Console.WriteLine("Press any key to exit...");
            Console.Read();
        }
        static void SetupBDC()
        {
            SqlSessionProvider.Instance().SetSharedResourceProviderToUse(yourSSPName);
        }
        static void CreateFinderMethod()
        {

            LobSystemInstance mySysInstance = null;
            LobSystemInstanceCollection sysInsCollection = ApplicationRegistry.Instance.GetLobSystemInstancesLikeName("AdventureWorksSampleFromCode");
            foreach (LobSystemInstance sysInstance in sysInsCollection)
            {
                if (sysInstance.Name == "AdventureWorksSampleFromCode")
                {
                    mySysInstance = sysInstance;
                    break;
                }
            }
            EntityCollection entityColl = mySysInstance.LobSystem.Entities;
            foreach (Entity entity in entityColl)
            {
                if (entity.Name == "ProductModel")
                {
                    Method meth = entity.Methods.Create("GetProductModels", true, true);
                    meth.Properties.Add("RdbCommandText", "SELECT ProductModelID, Name, CatalogDescription FROM ProductModel WHERE Name LIKE @Name");
                    meth.Properties.Add("RdbCommandType", System.Data.CommandType.Text);
                    FilterDescriptor fd = meth.FilterDescriptors.Create("Name", true, "Microsoft.Office.Server.ApplicationRegistry.Runtime.WildcardFilter");
                    Parameter p1 = meth.Parameters.Create("@Name", true, Microsoft.Office.Server.ApplicationRegistry.MetadataModel.DirectionType.In, "Microsoft.Office.Server.ApplicationRegistry.Infrastructure.DotNetTypeReflector");
                    TypeDescriptor td1 = p1.CreateRootTypeDescriptor("Name", true, "System.String", null, fd, false);
                    Parameter p2 = meth.Parameters.Create("ProductModels", true, Microsoft.Office.Server.ApplicationRegistry.MetadataModel.DirectionType.Return, "Microsoft.Office.Server.ApplicationRegistry.Infrastructure.DotNetTypeReflector");
                    IList<Identifier> ids = new List<Identifier>(entity.Identifiers);
                    Identifier id = ids[0];
                    TypeDescriptor td2 = p2.CreateRootTypeDescriptor("ProductModelDataReader", true, "System.Data.IDataReader, System.Data, Version=2.0.3600.0, Culture=neutral, PublicKeyToken=b77a5c561934e089", null, null, true);
                    TypeDescriptor td21 = td2.ChildTypeDescriptors.Create("ProductModelDataRecord", true, "System.Data.IDataRecord, System.Data, Version=2.0.3600.0, Culture=neutral, PublicKeyToken=b77a5c561934e089", null, null, false);
                    TypeDescriptor td210 = td21.ChildTypeDescriptors.Create("ProductModelID", true, "System.Int32", id, null, false);
                    TypeDescriptor td211 = td21.ChildTypeDescriptors.Create("Name", true, "System.String", null, null, false);
                    TypeDescriptor td212 = td21.ChildTypeDescriptors.Create("CatalogDescription", true, "System.String", null, null, false);
                    MethodInstance methInst1 = meth.MethodInstances.Create("ProductModelFinder", true, td2, Microsoft.Office.Server.ApplicationRegistry.MetadataModel.MethodInstanceType.Finder);
                    MethodInstance methInst2 = meth.MethodInstances.Create("ProductModelSpecificFinder", true, td2, Microsoft.Office.Server.ApplicationRegistry.MetadataModel.MethodInstanceType.SpecificFinder);
                    IList<MethodInstance> methInstCollection = new List<MethodInstance>(entity.MethodInstances);
                    td1.SetDefaultValue(methInstCollection[0].Id, "%");
                    td1.SetDefaultValue(methInstCollection[1].Id, "%");
                    Console.WriteLine("Created the finder method successfully.");
                    break;
                }
            }
        }
    }
}

継承階層

System.Object
   Microsoft.Office.Server.ApplicationRegistry.Administration.MetadataObject
     Microsoft.Office.Server.ApplicationRegistry.Administration.AccessControlledMetadataObject
      Microsoft.Office.Server.ApplicationRegistry.Administration.Parameter

スレッドの安全性

この型のパブリックで静的な (Visual Basic では Shared) すべてのメンバは、スレッドセーフです。インスタンスメンバは、スレッドセーフであるとは保証されません。

次の方法で共有

Parameter クラス (Microsoft.Office.Server.ApplicationRegistry.Administration)

構文

備考

例

継承階層

スレッドの安全性

関連項目

参照

その他のリソース