Hash$Name

HashLib ››
Parent Previous Next

HASH$Name


Returns the hash algorithm name of the specified index.


Format

HASH$Name index result


Arguments

index

A pointer to a 32-bit integer containing the hash algorithm index. The lowest valid hash algorithm index is 0, and HASH_Count returns the total count of algorithms.


result

A pointer to an SRB which will receive the name of the algorithm corresponding to the specified index. This buffer should be 64 bytes long. The returned name will terminate with an ASCII 0 (NUL). The name will never exceed 64 bytes in length, including the trailing NUL. If the buffer is too small, a UOSErr_Buffer_Overflow error occurs, and the returned name will not terminate with a NUL.


Description

This service returns the name of the hash algorithm corresponding to the passed index value.


Condition Values Returned

Value

Meaning

SS_NORMAL

Successful completion.

HASHLIB_Invalid_Hash

The specified hash index did not match an installed hash algorithm.

UOSErr_Buffer_Overflow

The receive buffer was too small to contain the entire hash algorithm name.