ULRetrieveEncryptionKey function

Retrieves the encryption key from memory.

Syntax

ul_bool ULRetrieveEncryptionKey(
ul_char * key,
ul_u_short len,
ul_u_long * creator,
ul_u_long * feature-num
);

Parameters

key A pointer to a buffer in which to hold the retrieved encryption key.

len The length of the buffer that holds the encryption key with a terminating null character.

creator A pointer to the creator ID of the feature holding the encryption key. The default value is NULL.

feature-num A pointer to the feature number holding the encryption key. If feature-num is NULL, the application uses the UltraLite default value of 100.

Returns

True if the operation is successful.
False if the operation failed. This occurs if the feature was not found or if the supplied buffer length is insufficient to hold the key plus a terminating null character.

Remarks

On Palm OS, the encryption key is saved in dynamic memory as a Palm feature. Features are indexed by creator and a feature number.

Applies to Palm OS.