IXRStoryboard::SeekAlignedToLastTick (Compact 2013)

Article
04/19/2017

3/28/2014

This method advances a storyboard from the current position to a new position based on a specified time increment (synchronously).

Syntax

virtual HRESULT STDMETHODCALLTYPE SeekAlignedToLastTick(
    __in XRTimeSpan *pTimeSpan
) = 0;

Parameters

pTimeSpan
[in] An XRTimeSpan structure that represents a positive or negative time value that describes how far the timeline should move forward or backward from the beginning of the animation.

Return Value

Returns an HRESULT that indicates success or failure.

This method can also return one of the following error messages, which can apply to either the storyboard itself, or to its animations in the collection retrieved by IXRStoryboard::GetChildren.

Error message	Description
XR_E_STORYBOARD_BEGIN_INVALID_PROPERTY	XAML for Windows Embedded cannot begin this storyboard. The property to be animated is invalid.
XR_E_STORYBOARD_BEGIN_INVALID_TARGET	XAML for Windows Embedded cannot begin this storyboard. The specified target is invalid.
XR_E_STORYBOARD_BEGIN_NO_TARGET	XAML for Windows Embedded cannot begin this storyboard. There is no target to animate.
XR_E_STORYBOARD_BEGIN_INCOMPATIBLE_TYPE	XAML for Windows Embedded cannot begin this storyboard. There is no conversion available between the target properties and object.
XR_E_STORYBOARD_BEGIN_ANIMATION_COMPOSITION	XAML for Windows Embedded cannot compose this animation with the currently running animation.
XR_E_STORYBOARD_BEGIN_INVALID_KEYTIME	Invalid keytime specified for the beginning of this storyboard.
XR_E_STORYBOARD_MUST_BE_ROOT	Storyboard must be the root element of this timeline collection.
XR_E_STORYBOARD_SKIPTOFILL_NO_DURATION	No valid duration specified for this skip-to-fill operation.
XR_E_STORYBOARD_MODIFY_ACTIVE_ANIMATION	XAML for Windows Embedded cannot modify this active animation.

Remarks

The time change specified by this method is added or subtracted from the last clock tick of this clock animation. Values changed by SeekAlignedToLastTick are immediately updated, even though the window does not reflect these changes until it updates.

If this method is called when the storyboard begins, either right before or immediately after IXRStoryboard::Begin is called, the behavior for this method is the same as IXRStoryboard::Seek.

If an easing function is applied to the animation, this method jumps straight to the point in time given by pOffset, with no interpolation. Custom easing functions must use the value passed as the NormalizedTime reference in the IXREasingFunctionBase::Ease method to calculate where the easing method should be in the animation.

.NET Framework Equivalent

System.Windows.Media.Animation.Storyboard.SeekAlignedToLastTick

Requirements

Header	XamlRuntime.h
sysgen	SYSGEN_XAML_RUNTIME

Share via