SqlSessionProvider.SetSharedResourceProviderToUse Method (String)

  • Article

NOTE: This API is now obsolete.

Sets the Shared Resource Provider to use in the object model.

Namespace:  Microsoft.Office.Server.ApplicationRegistry.Infrastructure
Assembly:  Microsoft.SharePoint.Portal (in Microsoft.SharePoint.Portal.dll)

Syntax

'Declaration
<ObsoleteAttribute("O12 Application Registry API is deprecated. Please use BusinessData.",  _
    False)> _
Public Sub SetSharedResourceProviderToUse ( _
    sharedResourceProviderName As String _
)
'Usage
Dim instance As SqlSessionProvider
Dim sharedResourceProviderName As String

instance.SetSharedResourceProviderToUse(sharedResourceProviderName)

[ObsoleteAttribute("O12 Application Registry API is deprecated. Please use BusinessData.", 
    false)]
public void SetSharedResourceProviderToUse(
    string sharedResourceProviderName
)

Parameters

  • sharedResourceProviderName
    Type: System.String

    The Shared Services Provider name to use. For example, SharedServices1.

Remarks

If you are using the object model in a Web context, you cannot use this method to set the Shared Services Provider. In this case, the Business Data Catalog uses the default Shared Services Provider automatically. Calling this method in a Web Part or in the context of a Web application throws an exception.

Examples

The Business Data Catalog is implemented as a Microsoft Office SharePoint Server 2007 shared service and is shared across a Shared Resource Provider. Therefore, before you can use the ApplicationRegistry object, you must reference the Shared Resource Provider associated with the Business Data Catalog.

The following code example shows how to set the default Shared Services Provider (SSP) in your local server farm for use with the Business Data Catalog, and how to display the names of the systems that are registered in the Business Data Catalog. Specifying the SSP is the first step in setting up a console application to work with the Business Data Catalog.

After you specify the Shared Resource Provider, you can use the ApplicationRegistry object to get the LobSystemInstance objects that are registered with the Business Data Catalog, as shown in the following example.

Prerequisites

  • Ensure a Shared Service Provider is already created.

  • Replace the constant value EnterYourSSPNameHere in the code with the name of your Shared Resource Provider.

Project References

Add the following Project References in your console application code project before running this sample:

  • Microsoft.SharePoint

  • Microsoft.SharePoint.Portal

  • Microsoft.Office.Server

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

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

        static void Main(string[] args)
        {
            SetupBDC();
            DisplayLOBSystemsinBDC();
            Console.WriteLine("Press any key to exit...");
            Console.Read();
        }
        static void SetupBDC()
        {
            SqlSessionProvider.Instance().SetSharedResourceProviderToUse(yourSSPName);
        }
        static void DisplayLOBSystemsinBDC()
        {
            NamedLobSystemInstanceDictionary sysInstances = ApplicationRegistry.GetLobSystemInstances();
            Console.WriteLine("Listing system instances...");
            foreach (String name in sysInstances.Keys)
            {
                Console.WriteLine(name);
            }
        }
    }

}

See Also

Reference

SqlSessionProvider Class

SqlSessionProvider Members

SetSharedResourceProviderToUse Overload

Microsoft.Office.Server.ApplicationRegistry.Infrastructure Namespace