ModulePage.GetScopeStatusSummary(Connection, String, String) Method

Definition

Retrieves the status summary of the management scope.

protected:
 static System::String ^ GetScopeStatusSummary(Microsoft::Web::Management::Client::Connection ^ connection, System::String ^ configurationPath, System::String ^ locationSubPath);
protected static string GetScopeStatusSummary (Microsoft.Web.Management.Client.Connection connection, string configurationPath, string locationSubPath);
static member GetScopeStatusSummary : Microsoft.Web.Management.Client.Connection * string * string -> string

Parameters

connection
Connection

The Connection object that is associated with the ModulePage object.

configurationPath
String

The configuration path for the scope.

locationSubPath
String

The name of a location tag.

Returns

A description of the configuration information.

Examples

The following example displays the following output when the page is at the server connection level.

GetScopeStatusSummary = Configuration: 'localhost' applicationHost.config or root web.config

void testScopeStat() {

    Connection con = (Connection) GetService(typeof(Connection));
    if (con == null)
        return;
    SH.Con = con;
    string scopeStatSum = 
        GetScopeStatusSummary(
        this.Connection, "", ""
        );
    Trace.WriteLine("GetScopeStatusSummary = " 
        + scopeStatSum);
}

Remarks

The configurationPath and locationSubPath parameters can be null.

Applies to