UlFromSzHex

  • Article

This content is outdated and is no longer being maintained. It is provided as a courtesy for individuals who are still using these technologies. This page may contain URLs that were valid when originally published, but now link to sites or pages that no longer exist.

Converts a null-terminated string of hexadecimal digits into an unsigned long integer.

Header file:

Mapidefs.h

Implemented by:

MAPI

Called by:

Client applications and service providers

 
ULONG UlFromSzHex(
LPCTSTR lpsz
);

Parameters

  • lpsz
    [in] Pointer to the null-terminated string to be converted. The lpsz parameter must not exceed 65536 characters.

Return Value

UlFromSzHex returns an unsigned long integer. If the string does not begin with at least one hexadecimal digit, zero is returned.

Remarks

The UlFromSzHex function stops converting when it reaches the first character in the string that is not a hexadecimal digit. For example, given the string "5a", UlFromSzHex returns the integer value 90. Given the string "5g5h", the function returns the integer value 5. Given the string "g5h5", UlFromSzHex returns zero.

UlFromSzHex is sensitive to diacritical differences but allows both 'a' through 'f' and 'A' through 'F' for hexadecimal digits. Strings in the Unicode and DBCS formats are supported. The length limit on lpsz is in characters, not necessarily bytes.