Share via

Connection.StartConfigurationManagement Method

  • Reference

Definition

Namespace:
Microsoft.Web.Management.Client
Assembly:
Microsoft.Web.Management.dll

Sets the configuration path of the specified site.

Overloads

StartConfigurationManagement(ManagementConfigurationPath)

Sets the configuration path of the specified site.
StartConfigurationManagement(ManagementConfigurationPath, Type)

Sets the configuration path of the specified site, using the specified page type.

StartConfigurationManagement(ManagementConfigurationPath)

Sets the configuration path of the specified site.

public:
 bool StartConfigurationManagement(Microsoft::Web::Management::Server::ManagementConfigurationPath ^ configurationPath);
public bool StartConfigurationManagement (Microsoft.Web.Management.Server.ManagementConfigurationPath configurationPath);
member this.StartConfigurationManagement : Microsoft.Web.Management.Server.ManagementConfigurationPath -> bool
Public Function StartConfigurationManagement (configurationPath As ManagementConfigurationPath) As Boolean

Parameters

configurationPath
ManagementConfigurationPath

The ManagementConfigurationPath object of the site to be managed.

Returns

Boolean

true in all cases.

Examples

void doStartConfigMgmt(IServiceProvider sp) {

    Connection con = (Connection)sp.GetService(typeof(Connection));
    try {
        ManagementConfigurationPath newConfigurationPath = ManagementConfigurationPath.CreateSiteConfigurationPath(_tbSite.Text);
        con.StartConfigurationManagement(newConfigurationPath);
    } catch (Exception ex) {
        ShowMessage(ex.ToString(), "Fail: CreateSiteConfigurationPath for  " + _tbSite.Text );
    }

}

void doStrtConfgMgntApp(IServiceProvider sp, string siteNm, string appPath) {

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

    ManagementConfigurationPath newConfigurationPath = ManagementConfigurationPath
        .CreateApplicationConfigurationPath(siteNm, appPath);

    bool b = con.StartConfigurationManagement(newConfigurationPath);
    if (b != true)
        ShowMessage("Failure: \n CreateApplicationConfigurationPath for site "
            + siteNm + "  App Path" + appPath, "Error");

}

void doStrtConfgMgntSite(IServiceProvider sp, string siteNm) {

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

    ManagementConfigurationPath newConfigurationPath = ManagementConfigurationPath
        .CreateSiteConfigurationPath(siteNm);

    bool b = con.StartConfigurationManagement(newConfigurationPath);
    if (b != true)
        ShowMessage("Failure: \n CreateSiteConfigurationPath for site " + siteNm, "Error");

}


void testStrtConfgMgntFile(IServiceProvider sp) {
    doStrtConfgMgntFile(sp, "rws", "/rAp2", "Bin");
}

bool doStrtConfgMgntFile(IServiceProvider sp, string siteNm, string appPath, string filePath) {

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

    ManagementConfigurationPath newConfigurationPath = ManagementConfigurationPath
        .CreateFileConfigurationPath(siteNm, appPath, filePath);

    bool b = con.StartConfigurationManagement(newConfigurationPath);
    if (b != true)
        ShowMessage("Failure: \n CreateFileConfigurationPath for site " 
            + siteNm, "Error");
    return b;
}

Remarks

If this call is successful, the method navigates to the configuration path of the selected server, site, application, or folder. The configurationPath parameter string elements are not case-sensitive.

Applies to

StartConfigurationManagement(ManagementConfigurationPath, Type)

Sets the configuration path of the specified site, using the specified page type.

public:
 bool StartConfigurationManagement(Microsoft::Web::Management::Server::ManagementConfigurationPath ^ configurationPath, Type ^ pageType);
public bool StartConfigurationManagement (Microsoft.Web.Management.Server.ManagementConfigurationPath configurationPath, Type pageType);
member this.StartConfigurationManagement : Microsoft.Web.Management.Server.ManagementConfigurationPath * Type -> bool
Public Function StartConfigurationManagement (configurationPath As ManagementConfigurationPath, pageType As Type) As Boolean

Parameters

configurationPath
ManagementConfigurationPath

The ManagementConfigurationPath of the site to be managed.

pageType
Type

The type of the page.

Returns

Boolean

true if the method call was successful; otherwise, false.

Examples

bool doStartConfigMgmtType(IServiceProvider sp) {

    Connection con = (Connection)sp.GetService(typeof(Connection));
    ManagementConfigurationPath newConfigurationPath =
        ManagementConfigurationPath.CreateSiteConfigurationPath(_tbType.Text);

    IControlPanel controlPanel = (IControlPanel)GetService(typeof(IControlPanel));

    bool b = con.StartConfigurationManagement(newConfigurationPath, controlPanel.ControlPanelPage.PageType);

    if (b != true)
        ShowMessage("CreateSiteConfigurationPath for site " + _tbSite.Text + " failed ", "Error");
    return b;
}

Remarks

If this call is successful, the method navigates to the configuration path of the selected site. The configurationPath parameterstring elements are not case-sensitive.

Applies to