Public API

Collaboration diagram for Public API:

Modules
	XXH32 family
	XXH64 family
	XXH3 family

Macros
#define	XXH_PUBLIC_API   /* do nothing */
	Marks a global symbol.
#define	XXH_PUBLIC_API   /* do nothing */
	Marks a global symbol.
#define	XXH_VERSION_NUMBER   (XXH_VERSION_MAJOR *100*100 + XXH_VERSION_MINOR *100 + XXH_VERSION_RELEASE)
	Version number, encoded as two digits each.

Enumerations
enum	XXH_errorcode { XXH_OK = 0 , XXH_ERROR }
	Exit code for the streaming API. More...

Functions
XXH_PUBLIC_API XXH_CONSTF unsigned	XXH_versionNumber (void)
	Obtains the xxHash version.

Detailed Description

Contains details on the public xxHash functions.

Enumeration Type Documentation

XXH_errorcode

enum XXH_errorcode

Exit code for the streaming API.

Enumerator
XXH_OK	OK
XXH_ERROR	Error

Definition at line 500 of file xxhash.h.

Function Documentation

XXH_versionNumber()

XXH_PUBLIC_API XXH_CONSTF unsigned XXH_versionNumber

(

void

)

Obtains the xxHash version.

This is mostly useful when xxHash is compiled as a shared library, since the returned value comes from the library, as opposed to header file.

Returns

XXH_VERSION_NUMBER of the invoked library.