IPluginExecutionContext IPluginExecutionContext IPluginExecutionContext IPluginExecutionContext Interface

Definition

Defines the contextual information passed to a plug-in at run-time. Contains information that describes the run-time environment that the plug-in is executing in, information related to the execution pipeline, and entity business information.

public interface class IPluginExecutionContext : Microsoft::Xrm::Sdk::IExecutionContext
public interface IPluginExecutionContext : Microsoft.Xrm.Sdk.IExecutionContext
type IPluginExecutionContext = interface
    interface IExecutionContext
Public Interface IPluginExecutionContext
Implements IExecutionContext
Derived
Implements

Remarks

The execution context is passed to a plug-in at run time in the System.IServiceProvider parameter of the Execute(IServiceProvider) method. You can obtain the context from the service provider as shown in the following plug-in code.

// Obtain the execution context from the service provider.
IPluginExecutionContext context = (IPluginExecutionContext)
    serviceProvider.GetService(typeof(IPluginExecutionContext));

Properties

BusinessUnitId BusinessUnitId BusinessUnitId BusinessUnitId

Gets the GUIDGUID of the business unit that the user making the request, also known as the calling user, belongs to.

(Inherited from IExecutionContext)
CorrelationId CorrelationId CorrelationId CorrelationId

Gets the GUID for tracking plug-in or custom workflow activity execution.

(Inherited from IExecutionContext)
Depth Depth Depth Depth

Gets the current depth of execution in the call stack.

(Inherited from IExecutionContext)
InitiatingUserId InitiatingUserId InitiatingUserId InitiatingUserId

Gets the GUID of the system user account under which the current pipeline is executing.

(Inherited from IExecutionContext)
InputParameters InputParameters InputParameters InputParameters

Gets the parameters of the request message that triggered the event that caused the plug-in to execute.

(Inherited from IExecutionContext)
IsExecutingOffline IsExecutingOffline IsExecutingOffline IsExecutingOffline

Gets whether the plug-in is executing from the Microsoft Dynamics 365 for Microsoft Office Outlook with Offline Access client while it is offline.

(Inherited from IExecutionContext)
IsInTransaction IsInTransaction IsInTransaction IsInTransaction

Gets a value indicating if the plug-in is executing within the database transaction.

(Inherited from IExecutionContext)
IsOfflinePlayback IsOfflinePlayback IsOfflinePlayback IsOfflinePlayback

Gets a value indicating if the plug-in is executing as a result of the Microsoft Dynamics 365 for Microsoft Office Outlook with Offline Access client transitioning from offline to online and synchronizing with the Microsoft Dynamics 365 server.

(Inherited from IExecutionContext)
IsolationMode IsolationMode IsolationMode IsolationMode

Gets a value indicating if the plug-in is executing in the sandbox.

(Inherited from IExecutionContext)
MessageName MessageName MessageName MessageName

Gets the name of the Web service message that is being processed by the event execution pipeline.

(Inherited from IExecutionContext)
Mode Mode Mode Mode

Gets the mode of plug-in execution.

(Inherited from IExecutionContext)
OperationCreatedOn OperationCreatedOn OperationCreatedOn OperationCreatedOn

Gets the date and time that the related System Job was created.

(Inherited from IExecutionContext)
OperationId OperationId OperationId OperationId

Gets the GUID of the related System Job.

(Inherited from IExecutionContext)
OrganizationId OrganizationId OrganizationId OrganizationId

Gets the GUID of the organization that the entity belongs to and the plug-in executes under.

(Inherited from IExecutionContext)
OrganizationName OrganizationName OrganizationName OrganizationName

Gets the unique name of the organization that the entity currently being processed belongs to and the plug-in executes under.

(Inherited from IExecutionContext)
OutputParameters OutputParameters OutputParameters OutputParameters

Gets the parameters of the response message after the core platform operation has completed.

(Inherited from IExecutionContext)
OwningExtension OwningExtension OwningExtension OwningExtension

Gets a reference to the related SdkMessageProcessingingStep or ServiceEndpoint.

(Inherited from IExecutionContext)
ParentContext ParentContext ParentContext ParentContext

Gets the execution context from the parent pipeline operation.

PostEntityImages PostEntityImages PostEntityImages PostEntityImages

Gets the properties of the primary entity after the core platform operation has been completed.

(Inherited from IExecutionContext)
PreEntityImages PreEntityImages PreEntityImages PreEntityImages

Gets the properties of the primary entity before the core platform operation has begins.

(Inherited from IExecutionContext)
PrimaryEntityId PrimaryEntityId PrimaryEntityId PrimaryEntityId

Gets the GUID of the primary entity for which the pipeline is processing events.

(Inherited from IExecutionContext)
PrimaryEntityName PrimaryEntityName PrimaryEntityName PrimaryEntityName

Gets the name of the primary entity for which the pipeline is processing events.

(Inherited from IExecutionContext)
RequestId RequestId RequestId RequestId

Gets the GUID of the request being processed by the event execution pipeline.

(Inherited from IExecutionContext)
SecondaryEntityName SecondaryEntityName SecondaryEntityName SecondaryEntityName

Gets the name of the secondary entity that has a relationship with the primary entity.

(Inherited from IExecutionContext)
SharedVariables SharedVariables SharedVariables SharedVariables

Gets the custom properties that are shared between plug-ins.

(Inherited from IExecutionContext)
Stage Stage Stage Stage

Gets the stage in the execution pipeline that a synchronous plug-in is registered for.

UserId UserId UserId UserId

Gets the GUID of the system user for whom the plug-in invokes web service methods on behalf of.

(Inherited from IExecutionContext)

Applies to