PA_GetTimeParameter

version 2003

PA_GetTimeParameter (params; index) → long

Parameter	Type		Description
params	PA_PluginParameters	→	Parameters received in PluginMain
index	short	→	Index of the parameter in params
Function result	long	←	Value (of type long) of the index parameter

Description

The routine PA_GetTimeParameter returns the value of the index parameter in params. As in 4D, the time type is basically the same as long; this routine returns a long, as PA_GetLongParameter does.

See Create a new plugin for a description of parameter accessors.

NOTE
:

The first parameter starts at index 1

Example

A plug-in routine is declared for the 4D developer as:

PluginRoutine(adate;anArray;aTime)

The 3rd parameter (the time) is retrieved with this code:

   aLong = PA_GetTimeParameter(params, 3);

See Also

Create a new plugin .

Error Handling


 
  
   PA_GetLastError

keeps the last error that occurred before calling the routine.