| |
| BOOL CompareText( |
| |
LONG*lpnOffset, |
|
| |
LPCTSTR lpszBuffer, |
|
| |
LONG cchBuffer, |
|
| |
BOOL bCaseSensitive |
|
| ); |
The CompareText method compares a text string against the
contents of the current message part.
Parameters
- lpnOffset
- Pointer to a long integer which specifies the offset in the
message at which to begin the comparison. This value will be
updated when the method returns to indicate the offset position in
the message where the comparison ended.
- lpszBuffer
- Pointer to a string buffer which contains the text that is to
be compared against the body of the message.
- cchBuffer
- The number of characters in the buffer that should be compared
against the body of the message.
- bCaseSensitive
- Boolean flag which specifies that the comparison should be case
sensitive.
Return Value
If the text buffer matches the contents of the current message
body, the method will return a non-zero value, and the
lpnOffset argument will be set to position in the buffer where
the match terminated. If the text buffer does not match, the method
will return a value of zero, and the lpnOffset argument will
be set to the position of the first non-matching character. The
method will also return zero if one of the arguments is invalid. To
get extended error information, call GetLastError.
Requirements
Minimum Desktop Platform: Windows 7 (Service Pack 1)
Minimum Server Platform: Windows Server 2008 R2 (Service Pack 1)
Header File: cstools10.h
Import Library: csmsgv10.lib
Unicode: Implemented as Unicode and ANSI versions.
See Also
AppendText,
ClearText, GetText,
SetText
|
|