DdGetSoundexMapping() - get Soundex phonetic mapping for a string
DdGetSoundexMapping() - get Soundex phonetic mapping for a string
Prototype:
void DdGetSoundexMapping(
const char *inString, /* [IN] source string */
char *outString, /* [OUT] result string */
int outStringLength); /* [IN] max length for outString */
Description:
|
DdGetSoundexMapping() is the API level equivalent to the ddlCalc() string function _soundex().
Description of Parameter inString:
|
const char *inString is the null-terminated ascii source word or name to be processed.
*inString may contain any number of characters; but only the first six
alphabetic characters are considered.
|
Description of Parameter outString:
|
char *outString is user supplied buffer where the result string is stored
as a null terminated ascii string.
The maximum result string size is 6 characters plus the terminating null character.
The first character of the result string is an upper case alpha; the remaining
characters are ascii digits {'0', '1', '2', '3', '4', '5', '6'}.
If *inString contains no alphabetic characters, the result string is null.
|
Description of Parameter outStringLength:
|
int outStringLength is the maximum number of characters (including the null terminator) that can
be stored into *outString.
|
|