Extensions.ExternalServiceProvider.DisposeProvider
Jump to navigation
Jump to search
Classification
| Name | DisposeProvider |
| Short Description | Informs the runtime system |
| Class | Action |
| Extension | OTX ExternalServiceProvider extension |
| Group | ExternalServiceProvider related actions |
| Exceptions | |
| Checker Rules | |
| Standard Compliant | Yes |
OTL Syntax
ActionRealisation ExternalServiceProvider.DisposeProvider(esp:ServiceProviderTerm serviceProvider);
Description
DisposeProvider is an ActionRealisation that informs the runtime system, that the instance of the service provider is no longer needed within OTX. Depending on the underlying implementation of the external service provider, all used resources can be released. After calling this action the appropriate IsDisposed term specifying the ServiceProvider will return true.
Properties
| Name | Data Type | Class | Default | Cardinality | Description |
| serviceProvider | esp:ServiceProvider | Term | - | [1..1] | This ServiceProvider will be disposed. |
OTL Examples
/// Signatures
package ExternalServiceProvider.ServiceProviderSignature ServiceProviderSignature1
{
ExternalServiceProvider.ConstructorSignature ConstructorSignature1(String ConstructorExternalInParameter1, String ConstructorExternalInParameter2, String ConstructorExternalInParameter3);
ExternalServiceProvider.EventSignature EventSignature1(String EventValueParameterDeclaration1, String EventValueParameterDeclaration2);
ExternalServiceProvider.PropertySignature PropertySignature1(String PropertyValueDeclaration1) accessType READ-ONLY;
ExternalServiceProvider.PropertySignature PropertySignature2(String PropertyValueDeclaration1) accessType WRITE-ONLY;
ExternalServiceProvider.ServiceSignature ServiceSignature1(in String ExternalInParameterDeclaration1, ref String ExternalInOutParameterDeclaration1, out String ExternalOutParameterDeclaration1) throws ExternalServiceProvider.ConfigurationException, ExternalServiceProvider.ExecuteException, ExternalServiceProvider.ProviderServiceException;
}
package HMI.ScreenSignature ScreenSignature1();
/// Global Declarations
public procedure main()
{
/// Local Declarations
ExternalServiceProvider.PropertyFlag PropertyFlag = @PropertyFlag:READ-ONLY;
ExternalServiceProvider.ServiceProvider ServiceProvider1;
String String1;
String String2;
String String3;
/// Flow
ExternalServiceProvider.CreateProvider(ServiceProvider1, ServiceProviderSignature1, ConstructorSignature1, {ConstructorExternalInParameter1 = String1, ConstructorExternalInParameter2 = String1, ConstructorExternalInParameter3 = String3});
ExternalServiceProvider.DisposeProvider(ServiceProvider1);
}
