UDF_JUMPTIME UDF IDL INTERFACE MANUAL UDF_JUMPTIME
NAME
UDF_JUMPTIME
USAGE
UDF_JUMPTIME, fh, [Y, D, H, M, S], {PosFmt}
UDF_JUMPTIME, fh, Y, D, H, M, S, {PosFmt}
INPUT DEFINITIONS
fh - Index into the information array to the UDF from which data is to be read. fh is the return value obtained from call to UDF_OPEN for this UDF source.
Y - Year of data to jump to
D - Day of data to jump to
H - Hour of data to jump to
M - Minute of data to jump to
S - Second of data to jump to
PosFmt - Optional parameter specifying how to position the file pointer in the time jump.. If no value is specified it is defaulted to the blocking parameter found in the PIDF for the UDF. Options include:
0 - Postiion to nearest time
1 - Postiion to beginning of data containing the time
RETURN DEFINITION
None.
DESCRIPTION
UDF_JUMPTIME() positions the file pointer of the UDF associated with fh to the input time. The positioning is made according to PosFmt. If PosFmt is not input then the positioning occurs according to the PIDF blocking field value for the UDF.
ERRORS
USAGE : key = UDF_JUMPTIME, fh, [Y, D, H, M, S], {PosFmt}
USAGE : key = UDF_JUMPTIME, fh, Y, D, H, M, S, {PosFmt}
UDF_JUMPTIME : Time must be [Y, D, H, M, S]
UDF_JUMPTIME : No Data For This Time
APPLICABLE FORMATS
UDF V2.2, UDF V2.1, IDFS V2.1
RESTRICTIONS
None.
SEE ALSO
None. ret_codes (1H)
Dec 6, 2002
&larr Previous TOC HOME Next &rarr
UDF_EOF UDF_KEY