Method ITcTask:GetCycleTime

Querying the task cycle time in nanoseconds, i.e. time between "begin of task" and next "begin of task".

Syntax

virtual HRESULT TCOMAPI GetCycleTime(PULONG 
pCycleTimeNS)=0;

Method ITcTask:GetCycleTime 1: Return value

If successful, S_OK ("0") or another positive value will be returned, cf. Return values. Extended messages refer in particular to the column HRESULT in ADS Return Codes.

E_POINTER if the parameter pCnt = NULL.

Parameter

Name

Type

Description

pCycleTimeNS

PULONG

[out] The configured task cycle time is stored in nanoseconds in this parameter.

Sample30: Timing Measurement illustrates the use of this method.