TrackingService.TryReloadProfile(Type, Guid, TrackingProfile) Method
Definition
Important
Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.
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.
protected public:
abstract bool TryReloadProfile(Type ^ workflowType, Guid workflowInstanceId, [Runtime::InteropServices::Out] System::Workflow::Runtime::Tracking::TrackingProfile ^ % profile);
protected internal abstract bool TryReloadProfile(Type workflowType, Guid workflowInstanceId, out System.Workflow.Runtime.Tracking.TrackingProfile profile);
abstract member TryReloadProfile : Type * Guid * TrackingProfile -> bool
Protected Friend MustOverride Function TryReloadProfile (workflowType As Type, workflowInstanceId As Guid, ByRef profile As TrackingProfile) As Boolean
Parameters
- profile
- TrackingProfile
When this method returns, contains the TrackingProfile to load. This parameter is passed uninitialized.
Returns
true
if a new TrackingProfile should be loaded; otherwise, false
. If true
, the TrackingProfile is returned in profile
.
Remarks
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.