Application.AddApplication メソッド (Microsoft.SharePoint.Portal.SingleSignon)
企業アプリケーション定義を追加または変更します。
名前空間: Microsoft.SharePoint.Portal.SingleSignon
アセンブリ: Microsoft.SharePoint.Portal.SingleSignon (microsoft.sharepoint.portal.singlesignon.dll 内)
構文
'宣言
<SingleSignonPermissionAttribute(SecurityAction.Demand, Access:=SingleSignonAccess.Minimal)> _
Public Shared Sub AddApplication ( _
App As ApplicationInfo, _
rgAppFields As ApplicationField(), _
appcd As ApplicationCreationDisposition _
)
'使用
Dim App As ApplicationInfo
Dim rgAppFields As ApplicationField()
Dim appcd As ApplicationCreationDisposition
Application.AddApplication(App, rgAppFields, appcd)
[SingleSignonPermissionAttribute(SecurityAction.Demand, Access=SingleSignonAccess.Minimal)]
public static void AddApplication (
ApplicationInfo App,
ApplicationField[] rgAppFields,
ApplicationCreationDisposition appcd
)
パラメータ
- App
追加される企業アプリケーション定義を指定する ApplicationInfo オブジェクト。
- rgAppFields
企業アプリケーション定義のフィールドを含む ApplicationField データ型。使用できる ApplicationField データ型は最大 5 つです。1 つ以上の ApplicationField データ型を指定する必要があります。
appcd
企業アプリケーション定義の作成方法を指定する ApplicationCreationDisposition 値の 1 つ。企業アプリケーション定義が存在しない場合は、ApplicationCreationDisposition にかかわらず企業アプリケーション定義が作成されます。
企業アプリケーション定義が存在し、ApplicationCreationDisposition.Overwrite が指定され、ApplicationType データ型が同じ場合は、企業アプリケーション定義は上書きされます。
備考
シングル サインオン データベースに企業アプリケーション定義を追加した後でのみ、資格情報の取得または指定を行うことができます。シングル サインオン管理者アカウントまたはアプリケーション定義管理者アカウントのメンバであるユーザーがアプリケーション定義を追加できます。
AddApplication メソッドの各呼び出しの結果は監査され、シングル サインオン データベースに保存されます。記録される ServiceAction 列挙は、AddApplication です。
例
次のコード例は、AddApplication メソッドの使用法を示しています。
[C#]
using System;
using Microsoft.SharePoint.Portal.SingleSignon;
namespace SSOSampleCode
{
/// <summary>
/// Sample code for SharePoint Portal Single SignOn.
/// </summary>
class CMainEntry
{
[STAThread]
static void Main(string[] args)
{
try
{
//Create the application fields (max 5 fields).
Application.ApplicationField[] rgFields = new Application.ApplicationField[5];
rgFields[0] = new Application.ApplicationField(
"Field1 Label", //Application field name
true); //true == mask in the UI, false == don't mask in the UI
rgFields[1] = new Application.ApplicationField(
"Field2 Label",
false);
rgFields[2] = new Application.ApplicationField(
"Field3 Label",
true);
rgFields[3] = new Application.ApplicationField(
"Field4 Label",
false);
rgFields[4] = new Application.ApplicationField(
"Field5 Label",
true);
//Create group application information data.
Application.ApplicationInfo App = new Application.ApplicationInfo(
"MyIndividualApplicationID",
"My Individual Applicaiton Display Name",
Application.ApplicationType.Individual,
"someone@someplace.someext");
//Now, add the application.
Application.AddApplication(
App,
rgFields,
Application.ApplicationCreationDisposition.CreateNew);
Console.WriteLine("Successfully added the individual application!");
//Get the application.
Application.ApplicationInfo MyApp = null;
Application.GetApplication(
"MyIndividualApplicationID",
ref MyApp);
Console.WriteLine("Application Information:");
Console.WriteLine("Application ID: " + MyApp.ApplicationName);
Console.WriteLine("Application friendly name: " + MyApp.ApplicationFriendlyName);
Console.WriteLine("Application contact: " + MyApp.ContactName);
Console.WriteLine("Application type: " + MyApp.Type);
//Now, delete the application.
Application.DeleteApplication("MyIndividualApplicationID");
Console.WriteLine("Successfully deleted the individual application!");
}
catch (SingleSignonException esso)
{
Console.WriteLine("SingleSignonException caught.");
Console.WriteLine("Exception Code: " + "0x" + esso.LastErrorCode.ToString("x"));
Console.WriteLine("Source: " + esso.Source);
Console.WriteLine("StackTrace: " + esso.StackTrace);
Console.WriteLine("MethodName: " + esso.TargetSite.Name);
Console.WriteLine("Message: " + esso.Message);
}
catch (Exception e)
{
Console.WriteLine("Exception caught.");
Console.WriteLine("Source: " + e.Source);
Console.WriteLine("StackTrace: " + e.StackTrace);
Console.WriteLine("MethodName: " + e.TargetSite.Name);
Console.WriteLine("Message: " + e.Message);
}
}
}
}
関連項目
参照
Application クラス
Application メンバ
Microsoft.SharePoint.Portal.SingleSignon 名前空間