This wiki is archived and useful information is being migrated to the main bzflag.org website

Difference between revisions of "Bz MD5"

From BZFlagWiki
Jump to: navigation, search
(remove all possible ambiguity that could possibly confuse anyone)
(version info, parameter types, spelling)
 
Line 1: Line 1:
 
{{BZFS_API_Doc}}{{BZFS_API_Funcs}}
 
{{BZFS_API_Doc}}{{BZFS_API_Funcs}}
==Syntax==
+
==Prototype==
const char *bz_MD5(const char* str);
+
BZF_API const char *bz_MD5(const char* str);
  
const char *bz_MD5(const void* data, size_t size);
+
BZF_API const char *bz_MD5(const void* data, size_t size);
  
 
==Parameters==
 
==Parameters==
; str : A pointer to a null terminated string to use as the MD5 source.
+
; const char* str : A pointer to a null terminated string to use as the MD5 source.
; data : A pointer to raw unterminated data to use as the MD5 source.
+
; const char* data : A pointer to raw unterminated data to use as the MD5 source.
; size : The size of the raw data.
+
; size_t size : The size of the raw data.
  
 
==Returns==
 
==Returns==
The 32-character lowercase hexedecmial (ASCII) representation of the MD5 hash.
+
The 32-character lowercase hexadecimal (ASCII) representation of the MD5 hash.
  
 
==Description==
 
==Description==
 
This function uses the same MD5 logic as BZFS.
 
This function uses the same MD5 logic as BZFS.
 +
 +
==Version==
 +
Requires BZFS 2.99.4 (20080524, r17281) or later

Latest revision as of 23:42, 25 May 2008

BZFS API Documentation This page contains part of the BZFS API documentation for use by Plug-ins on the BZFS server.
BZFS API Function. This page documents a BZFS_API Function, that is provided by the BZFS game server for plug-ins to call.

Prototype[edit]

BZF_API const char *bz_MD5(const char* str);

BZF_API const char *bz_MD5(const void* data, size_t size);

Parameters[edit]

const char* str 
A pointer to a null terminated string to use as the MD5 source.
const char* data 
A pointer to raw unterminated data to use as the MD5 source.
size_t size 
The size of the raw data.

Returns[edit]

The 32-character lowercase hexadecimal (ASCII) representation of the MD5 hash.

Description[edit]

This function uses the same MD5 logic as BZFS.

Version[edit]

Requires BZFS 2.99.4 (20080524, r17281) or later