Animations.GetAnimationsNumberOfTimesToPlay Method

Collapse AllExpand All Code: All Code: Multiple Code: C# Code: Visual Basic Code: Visual C++

[TCheckBoxFormControlObj]C#

[TCheckBoxFormControlObj]Visual Basic

[TCheckBoxFormControlObj]

Visual C++

DPSF API Documentation

Animations

..GetAnimationsNumberOfTimesToPlay Method

Animations Class

See Also Send Feedback

Returns the Number of times the given Animation ID is set to Play. Zero means the Animation will repeat forever.

NOTE: If the given Animation ID is invalid, -1 is returned.

Namespace: DPSF

Assembly: DPSF (in DPSF.dll) Version: 2.5.0.0

Syntax

public int GetAnimationsNumberOfTimesToPlay(

int iAnimationID

)

Visual Basic

Public Function GetAnimationsNumberOfTimesToPlay (

iAnimationID As Integer

) As Integer

Visual C++

public:

int GetAnimationsNumberOfTimesToPlay(

int iAnimationID

)

Parameters

iAnimationID

Type: System..::..Int32

The ID of the Animation to update

Return Value

Type: Int32

Returns the Number of times the given Animation ID is set to Play. Zero means the Animation will repeat forever. NOTE: If the given Animation ID is invalid, -1 is returned.