Extracts a the first token from a wide string, where the tokens are delimited by the characters in pszDelimiters.
This method is an improvement over the traditional strtok() because it is reentrant, and over the traditional strsep() because is does not modify the string being tokenized.
- Parameters
-
ppszSearchIn | [in,out] The address of a variable that on entry contains a pointer to the NULL termimated string to be searched. On exit, the pointer will be modified to point at the next character in the string to be searched or NULL. |
pszDelimiters | [ in ] A pointer to a NULL terminated string containing the character delimiters to be used to determine token boundaries. |
pbcsToken | [ out ] The address of a P6BCSTR structure which on success will be populated with the tokens information. You MUST not assume that pbcsToken->pString will point into *ppszSearchIn. As a result, you MUST not use the pointer value returned in any pointer arithmatic. |
- Returns
Success | P6R::eOk | The next token was found |
Failure | P6R::eInvalidArg | ppszSearchIn, pszDelimiters, *pszDelimiters or pbcsToken was NULL |
P6R::eEndOfRecord | There are no more characters in *ppszSearchIn to search. |