IExternal Service Execute Method

bool Execute(
	IExternalServer server,
	Document document,
	IExternalData data
)

Function Execute ( 
	server As IExternalServer,
	document As Document,
	data As IExternalData
) As Boolean

bool Execute(
	IExternalServer^ server, 
	Document^ document, 
	IExternalData^ data
)

abstract Execute : 
        server : IExternalServer * 
        document : Document * 
        data : IExternalData -> bool 

Parameters

server IExternalServer

An instance of a server that is to be executed.

document Document

The associated document. It may be NULL if the service is not being executed in a document.

data IExternalData

The associated service data.

Return Value

If a multi-server service returns false from the call, the service manager will stop the execution loop and marks the service execution as unsuccessful.

It is completely upon the service to decide what the communication with the server should be like, for it is the service provider who also defines what the server's interface looks like. It could be as simple as calling one method (e.g. Execute, Run, Calculate, etc.) or it could be a set of inquiries and executing calls to the server.

The framework invokes this method when the service is requested to be executed. The framework first checks what the applicable server (or servers, in a multi-server service) is and then it calls this method with that server as an argument.

Reference