CancelConfiguration2

While CancelConfiguration is still valid, CancelConfiguration2 is the preferred method and should be used instead, whenever possible.

Method

CancelConfiguration2(CancelConfigParameters parameters)

This method cancels the current client session that was initiated by the CreateConfigurationFromModel, CreateConfigurationFromXML, or LoadConfiguration method.

Parameters

The CancelConfiguration2() method requires a parameters parameter of type CancelConfigParameters.

CancelConfigParameters

CancelConfigParameters represents contextual information needed to cancel a given configuration. It does not contain any unique properties.

Inheritance

ParametersBase

The ParametersBase class is the base class for the parameters types that are passed in to various methods on the service. All parameters-derived types have the parameters listed below.

Properties

Data Type	Property	Description
bool	OmitConfigurationXmlFromResult	Returns or sets whether or not the configuration xml should be omitted from the result object. In general, the various methods that interact with the service will cause the configuration XML to be returned to the caller each time. It can be bandwidth and processing intensive to recreate the XML for each call. By setting this property to True, those steps will be skipped resulting in less data being transmitted and less server-side processing.
OperationsBehaviors	OperationBehaviors	This property is used to provide additional contextual behaviors to the service call. Provide an instance of the OperationBehaviors class with properties set to identify whether the configuration should be saved (via the Stateless services) or whether a StateGraph should be returned with the result of the web service call.
DiagnosticOutput	DiagnosticOutput	Specifies the type of diagnostic information that should be returned as a result of the service call. Available values include: None RulesExecuted RulesMessages RulesChanges This provides access to the rules that were executed along with their associated messages and changes. If set to a value other than None, the DiagnosticData property of the various Result objects will be populated.
bool	ValidateRequiredProperties	Returns or sets a value indicating whether the configuration should be validated for required Property values. The default value is true.

Returns

CancelConfigurationResult

An instance of CancelConfigurationResult is returned from the CancelConfiguration and CancelConfiguration2 methods. It does not contain any unique properties.

Inheritance

ConfigurationResult

The returned ConfigurationResult object contains general information about the configuration. It is a base class inherited many of the "result" objects, such as SaveConfigurationResult or CreateConfigurationResult.

Properties

Data Type	Property	Description
ConfigHeader	Header	Returns or sets the Config Header (ID + entity type).
ConfigurationResultCode	ResultCode Possible Values: Success Failure	Returns or sets whether the operation was successful and without errors.
ConfigurationResultMessage[]	ResultMessages	Returns or sets resulting messages from the configuration action.
ConfigurationFailureCode	FailureCode Possible Values: None SiteUnderMaintenance CompatEngineNotInitialized ServiceDisabled InvalidArgument InvalidOperation	In the event the ResultCode is Failure, returns a code identifying the type of failure
int	LineItemId	Returns or sets the line item id of the configuration. This is valid when the ConfigResult instance is a result of the IWebConfig.SaveConfiguration() or the IWebConfig.FixConfiguration() methods, otherwise the value is -1.
Configuration	Configuration	Returns or sets a Configuration object containing various properties relating to the current configuration. This will only ever be assigned if the Configuration is relevant to the operation that was executed.
ConfigurationStateGraphBase	StateGraph	Returns or sets a StateGraph object containing various properties relating to the current configuration. This will only ever be assigned if the ConfigParameters.OperationBehaviors.StateGraphParameters property is provided on the request.
DiagnosticData	DiagnosticData	Returns the DiagnosticData associated with the operation. This will only ever be assigned if theConfigParameters.DiagnosticOutput property is provided on the request.
SessionContext	SessionContext	Returns a SessionContext object containing server-side properties that pertain to the current configuration session.