FileFingerprint

FileFingerprint()

Syntax

Result$ = FileFingerprint(Filename$, Plugin [, Bits [, Offset [, Length [, HmacKey$ [, HmacKeyFormat]]]]])

Description

Returns a fingerprint for the specified file.

Parameters

FileName$ The file of which the fingerprint should be calculated.
Plugin
The plugin to use. It can be one of the following value:
  #PB_Cipher_CRC32: uses CRC32 algorithm. UseCRC32Fingerprint() needs to be called before to register this plugin.
  #PB_Cipher_MD5  : uses MD5 algorithm. UseMD5Fingerprint() needs to be called before to register this plugin.
  #PB_Cipher_SHA1 : uses SHA1 algorithm. UseSHA1Fingerprint() needs to be called before to register this plugin.
  #PB_Cipher_SHA2 : uses SHA2 algorithm. UseSHA2Fingerprint() needs to be called before to register this plugin.
  #PB_Cipher_SHA3 : uses SHA3 algorithm. UseSHA3Fingerprint() needs to be called before to register this plugin.
The plugin to use can be combined with the #PB_Cipher_HMAC flag to compute a HMAC (hash based message authentication code) instead of a regular fingerprint. In this case the "HmacKey$" parameter is needed as well. See StringFingerprint() for example usage of the HMAC flag.
Bits (optional)
The bits number to use for the fingerprint. It is only supported for the following plugin:
  #PB_Cipher_SHA2 : can be 224, 256 (default), 384 or 512.
  #PB_Cipher_SHA3 : can be 224, 256 (default), 384 or 512.
Offset (optional) The offset (in bytes) from the start of the file to begin the checksum calculation.

Length (optional) The length (in bytes) to use for the checksum calculation.

HmacKey$ (optional) The secret key to use in the HMAC computation. This parameter is only used if the #PB_Cipher_HMAC is added to the plugin parameter.
HmacKeyFormat (optional)
The string format to use for the HMAC key. This can be one of the following values:
  #PB_Ascii  : encode the key in ASCII
  #PB_UTF8   : encode the key on UTF-8 (default).
  #PB_Unicode: encode the key in Unicode

Return value

Returns the fingerprint if the calculation was successful. If the file isn't found or an error has happened, the result will be an empty string.

See Also

Fingerprint(), StartFingerprint(), StringFingerprint()

Supported OS

All

<- DeriveCipherKey() - Cipher Index - Fingerprint() ->

FileName$	The file of which the fingerprint should be calculated.
Plugin	The plugin to use. It can be one of the following value: #PB_Cipher_CRC32: uses CRC32 algorithm. UseCRC32Fingerprint() needs to be called before to register this plugin. #PB_Cipher_MD5 : uses MD5 algorithm. UseMD5Fingerprint() needs to be called before to register this plugin. #PB_Cipher_SHA1 : uses SHA1 algorithm. UseSHA1Fingerprint() needs to be called before to register this plugin. #PB_Cipher_SHA2 : uses SHA2 algorithm. UseSHA2Fingerprint() needs to be called before to register this plugin. #PB_Cipher_SHA3 : uses SHA3 algorithm. UseSHA3Fingerprint() needs to be called before to register this plugin. The plugin to use can be combined with the #PB_Cipher_HMAC flag to compute a HMAC (hash based message authentication code) instead of a regular fingerprint. In this case the "HmacKey$" parameter is needed as well. See StringFingerprint() for example usage of the HMAC flag.
Bits (optional)	The bits number to use for the fingerprint. It is only supported for the following plugin: #PB_Cipher_SHA2 : can be 224, 256 (default), 384 or 512. #PB_Cipher_SHA3 : can be 224, 256 (default), 384 or 512.
Offset (optional)	The offset (in bytes) from the start of the file to begin the checksum calculation.
Length (optional)	The length (in bytes) to use for the checksum calculation.
HmacKey$ (optional)	The secret key to use in the HMAC computation. This parameter is only used if the #PB_Cipher_HMAC is added to the plugin parameter.
HmacKeyFormat (optional)	The string format to use for the HMAC key. This can be one of the following values: #PB_Ascii : encode the key in ASCII #PB_UTF8 : encode the key on UTF-8 (default). #PB_Unicode: encode the key in Unicode