IPluginExecutionContext Interface

 

Applies To: Dynamics 365 (online), Dynamics 365 (on-premises), Dynamics CRM 2016, Dynamics CRM Online

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.

Namespace:   Microsoft.Xrm.Sdk
Assembly:  Microsoft.Xrm.Sdk (in Microsoft.Xrm.Sdk.dll)

Syntax

public interface IPluginExecutionContext : IExecutionContext

Public Interface IPluginExecutionContext
    Inherits IExecutionContext

Properties

	Name	Description
	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	Gets the GUID for tracking plug-in or custom workflow activity execution. (Inherited from IExecutionContext.)
	Depth	Gets the current depth of execution in the call stack.(Inherited from IExecutionContext.)
	InitiatingUserId	Gets the GUID of the system user account under which the current pipeline is executing.(Inherited from IExecutionContext.)
	InputParameters	Gets the parameters of the request message that triggered the event that caused the plug-in to execute.(Inherited from IExecutionContext.)
	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	Gets a value indicating if the plug-in is executing within the database transaction.(Inherited from IExecutionContext.)
	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	Gets a value indicating if the plug-in is executing in the sandbox.(Inherited from IExecutionContext.)
	MessageName	Gets the name of the Web service message that is being processed by the event execution pipeline.(Inherited from IExecutionContext.)
	Mode	Gets the mode of plug-in execution.(Inherited from IExecutionContext.)
	OperationCreatedOn	Gets the date and time that the related System Job was created.(Inherited from IExecutionContext.)
	OperationId	Gets the GUID of the related System Job.(Inherited from IExecutionContext.)
	OrganizationId	Gets the GUID of the organization that the entity belongs to and the plug-in executes under.(Inherited from IExecutionContext.)
	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	Gets the parameters of the response message after the core platform operation has completed.(Inherited from IExecutionContext.)
	OwningExtension	Gets a reference to the related SdkMessageProcessingingStep or ServiceEndpoint.(Inherited from IExecutionContext.)
	ParentContext	Gets the execution context from the parent pipeline operation.
	PostEntityImages	Gets the properties of the primary entity after the core platform operation has been completed.(Inherited from IExecutionContext.)
	PreEntityImages	Gets the properties of the primary entity before the core platform operation has begins.(Inherited from IExecutionContext.)
	PrimaryEntityId	Gets the GUID of the primary entity for which the pipeline is processing events.(Inherited from IExecutionContext.)
	PrimaryEntityName	Gets the name of the primary entity for which the pipeline is processing events.(Inherited from IExecutionContext.)
	RequestId	Gets the GUID of the request being processed by the event execution pipeline.(Inherited from IExecutionContext.)
	SecondaryEntityName	Gets the name of the secondary entity that has a relationship with the primary entity.(Inherited from IExecutionContext.)
	SharedVariables	Gets the custom properties that are shared between plug-ins.(Inherited from IExecutionContext.)
	Stage	Gets the stage in the execution pipeline that a synchronous plug-in is registered for.
	UserId	Gets the GUID of the system user for whom the plug-in invokes web service methods on behalf of.(Inherited from IExecutionContext.)

Remarks

The execution context is passed to a plug-in at run time in the System.IServiceProvider parameter of the Execute 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));

See Also

Microsoft.Xrm.Sdk Namespace
Understand the data context passed to a plug-in
Write plug-ins to extend business processes

Return to top

Microsoft Dynamics 365

© 2016 Microsoft. All rights reserved. Copyright