Connection.EndConfigurationManagement Method

Definition

Sets the configuration path to the root of the current connection.

Overloads

EndConfigurationManagement()

Sets the configuration path of the root of the current connection.

EndConfigurationManagement(Type)

Sets the configuration path of the root of the current connection by using the specified page type.

EndConfigurationManagement()

Sets the configuration path of the root of the current connection.

public:
 bool EndConfigurationManagement();
public bool EndConfigurationManagement ();
member this.EndConfigurationManagement : unit -> bool
Public Function EndConfigurationManagement () As Boolean

Returns

true if the ConfigurationPath property value was successfully reset; otherwise, false.

Examples

void doEndConfigMgmt(IServiceProvider sp) {

    Connection con = (Connection)sp.GetService(typeof(Connection));
    bool b = con.EndConfigurationManagement();
    if (b != true)
        ShowMessage("EndConfigurationManagement returned false", "Error");

}

Remarks

When this method is successful, the ConfigurationPath property is set to the root of the Connection object, and navigation proceeds from there.

Note

The root Connection object will be a site, server, or application.

Applies to

EndConfigurationManagement(Type)

Sets the configuration path of the root of the current connection by using the specified page type.

public:
 bool EndConfigurationManagement(Type ^ pageType);
public bool EndConfigurationManagement (Type pageType);
member this.EndConfigurationManagement : Type -> bool
Public Function EndConfigurationManagement (pageType As Type) As Boolean

Parameters

pageType
Type

The type of the page.

Returns

true if the ConfigurationPath property is set to the root of the Connection object; otherwise, false.

Examples

void doEndConfigMgmtSvr(IServiceProvider sp) {

    Connection con = (Connection)sp.GetService(typeof(Connection));
    IControlPanel controlPanel = (IControlPanel)GetService(typeof(IControlPanel));

    bool b = con.EndConfigurationManagement(controlPanel.ControlPanelPage.PageType);
    if (b != true)
        ShowMessage("EndConfigurationManagement returned false", "Error");

}

Remarks

When this method is successful, the ConfigurationPath property is set to the default site of the Connection object, and navigation proceeds from there.

Note

The root Connection object will be a site, server, or application.

Applies to