ExternalServiceRegistryExecuteService(Guid, Document, IExternalData) Method

public static ExternalServiceResult ExecuteService(
	Guid executionKey,
	Document document,
	IExternalData data
)

Public Shared Function ExecuteService ( 
	executionKey As Guid,
	document As Document,
	data As IExternalData
) As ExternalServiceResult

public:
static ExternalServiceResult ExecuteService(
	Guid executionKey, 
	Document^ document, 
	IExternalData^ data
)

static member ExecuteService : 
        executionKey : Guid * 
        document : Document * 
        data : IExternalData -> ExternalServiceResult 

Parameters

executionKey  Guid

Access key of the service to be executed. The key is not the same as the service's Id. It is the value that was returned to the caller who registered the service.

document  Document

The document for which the service is going to be executed.

data  IExternalData

The associated data. The type must be of the class defined by the service.

Return Value

Execution of a service should be invoked only by the application that registered the service. The execution will use the active server (or servers in the case of a multi-server service) currently set for the given document. If there is no server specifically set for the document the current application-wide server (or servers) will be applied.

Please note that recordable services may only be executed in a document that is currently modifiable. An exception will be thrown if it isn't so. This requirement does not apply to non-recordable services.

This method is primarily intended for executing of recordable services, for it is assumed that any changes made to the model during the service's execution are likely tied with the service's currently active servers. If the service was registered as non-recordable, changes to the model may still be made, but the framework does not assume any explicit or implicit correlations between the document changes and servers that caused them, therefore it is not recorded which server did what. This fact is very important, particularly in work-sharing environment. If it may happen that different local users can have different servers installed and available, it is imperative for a non-serialized service that its servers are completely compatible with (or indifferent to) document modifications made by other servers of the same service. The responsibility for complying with this assumption is entirely on the service's provider.

Reference