TrackingService::TryReloadProfile Method (Type^, Guid, TrackingProfile^%)

 

Must be overridden in the derived class, and when implemented, retrieves a new tracking profile for the specified workflow instance if the tracking profile has changed since it was last loaded.

Namespace:   System.Workflow.Runtime.Tracking
Assembly:  System.Workflow.Runtime (in System.Workflow.Runtime.dll)

public protected:
virtual bool TryReloadProfile(
	Type^ workflowType,
	Guid workflowInstanceId,
	[OutAttribute] TrackingProfile^% profile
) abstract

Parameters

workflowType
Type: System::Type^

The Type of the workflow instance.

workflowInstanceId
Type: System::Guid

The Guid of the workflow instance.

profile
Type: System.Workflow.Runtime.Tracking::TrackingProfile^%

When this method returns, contains the TrackingProfile to load. This parameter is passed uninitialized.

Return Value

Type: System::Boolean

true if a new TrackingProfile should be loaded; otherwise, false. If true, the TrackingProfile is returned in profile.

TryReloadProfile is called by the run-time tracking infrastructure to determine whether a new TrackingProfile should be loaded for the specified workflow instance. If a new TrackingProfile is required, it is returned in profile. If you want the run-time tracking infrastructure to stop tracking a workflow instance, your tracking service should return true and set profile equal to a null reference (Nothing in Visual Basic). Your tracking service can use workflowType or workflowInstanceId in whatever manner you choose to determine whether a tracking profile should be reloaded. For example, the SqlTrackingService only uses workflowInstanceId to decide whether the tracking profile should be reloaded. TryReloadProfile is called by the run-time tracking infrastructure according to its own tracking semantics, or in response to the host or a service calling WorkflowInstance::ReloadTrackingProfiles on a workflow instance.

The following example shows a basic implementation of the TryReloadProfile method. This example is from the Termination Tracking Service SDK sample. For more information, seeTermination Tracking Service Sample.

No code example is currently available or this language may not be supported.

.NET Framework
Available since 3.0
Return to top
Show: