Carbon


InitDateCache

Header: DateTimeUtils.h Carbon status: Supported

Initializes the date cache structure, which is used to store data for use by the StringToDate and StringToTime functions.

OSErr InitDateCache (
    DateCachePtr theCache
);
Parameter descriptions
theCache

A pointer to adate cache structure. This parameter can be a local variable, a pointer, or a locked handle.

function result

A result code.

DISCUSSION

You must call InitDateCache to initialize the date cache structure before using either the StringToDate or StringToTime functions. You must pass a pointer to a date cache structure. You have to declare the structure as a variable or allocate it in the heap.

If you are writing an application that allows the use of global variables, you can make your date cache structure a global variable and initialize it once, when you perform other global initialization.

InitDateCache calls the GetResource and LoadResource functions and it can also return the error codes they produce.

SPECIAL CONSIDERATIONS

InitDateCache may move memory; your application should not call this function at interrupt time.

AVAILABILITY

Supported in Carbon. Available in Carbon 1.0.2 and later when running Mac OS 8.1 or later.


© 2000 Apple Computer, Inc. (Last Updated 6/30/2000)