TimeInitialize
BOOL TimeInitialize(
LPCTSTR lpszLicenseKey,  
LPINITDATA lpData  
);

The TimeInitialize function initializes the library and validates the specified user license key at runtime. This must be the first function that an application calls before using any of the other functions in the library.

Parameters

lpszLicenseKey
Pointer to a null-terminated string that specifies the license key to be validated. A value of NULL indicates that the licensing information in the system registry should be validated.
lpData
Pointer to INITDATA data structure. This parameter may be NULL if the initialization data for the library is not required.

Return Value

If the function succeeds, the return value is non-zero. If the function fails, the return value is zero. To get extended error information, call TimeGetLastError. All other client functions will fail until a license key has been successfully validated.

Remarks

When a NULL license key is specified, the client library will only function on the development system. Before redistributing the application to an end-user, you must insure that this function is called with a valid license key.

If the lpData argument is specified, it must point to an INITDATA structure which has been initialized by setting the dwSize member to the size of the structure. All other structure members should be set to zero. If the function is successful, then the INITDATA structure will be filled with identifying information about the library.

Although it is only required that TimeInitialize be called once for the current process, it may be called multiple times; however, each call must be matched by a corresponding call to TimeUninitialize.

Requirements

Client: Requires Windows Vista, Windows XP or Windows 2000 Professional.
Server: Requires Windows Server 2008, Windows Server 2003 or Windows 2000 Server.
Header: Include cstools6.h.
Library: Use cstimav6.lib.
Unicode: Implemented as Unicode and ANSI versions.

See Also

GetNetworkTime, QueryNetworkTime, TimeUninitialize


Copyright © 2008 Catalyst Development Corporation. All rights reserved.