FILEDECRYPTOPTIONS (original) (raw)

Summary

The FILEDECRYPTOPTIONS structure provides information on loading encrypted files in LEADTOOLS.

Syntax

Members

uStructSize

Size of the structure. The size must be set before passing this structure to the LEAD functions. Use sizeof(FILEDECRYPTOPTIONS) to calculate this value.

uFlags

Reserved for future use, pass 0.

pszPassword

Optional password for loading the file. If this is NULL or is not the correct password, LEADTOOLS will try calling pfnCallback (if it is not NULL).

pfnCallback

Optional callback for loading the file. If not NULL, LEADTOOLS will try this callback when a decryption password is needed.

pUserData

Optional callback user data. This value will be passed to pfnCallback as the pUserData parameter.

Comments

pFILEDECRYPTOPTIONS is a pointer to a FILEDECRYPTOPTIONS structure.

If you pass this structure to LFileSettings::SetDecryptOptions and you set pszPassword to a value other than NULL, LEADTOOLS will make a copy of this string. So if you allocated this pointer, you will need to remember to free the pointer when you are done with this structure.

If you call LFileSettings::GetDecryptOptions, LEADTOOLS might set pszPassword to the internal buffer used to store the default password. You should NOT attempt to free this pointer. This pointer is only valid until this thread makes another call to LFileSettings::SetDecryptOptions. So if you need to use this pointer at a later time, you should make a copy.