StrIsIntlEqualA function (shlwapi.h)

Article
02/22/2024

Compares a specified number of characters from the beginning of two strings to determine if they are equal.

Syntax

BOOL StrIsIntlEqualA(
       BOOL  fCaseSens,
  [in] PCSTR pszString1,
  [in] PCSTR pszString2,
       int   nChar
);

Parameters

fCaseSens

Type: BOOL

The case sensitivity of the comparison. If this value is nonzero, the comparison is case-sensitive. If this value is zero, the comparison is not case-sensitive.

[in] pszString1

Type: PCTSTR

A pointer to the first null-terminated string to be compared.

[in] pszString2

Type: PCTSTR

A pointer to the second null-terminated string to be compared.

nChar

Type: int

The number of characters from the beginning of each string to be compared.

Return value

Type: BOOL

TRUE if the first nChar characters from the two strings are equal; otherwise, FALSE.

Remarks

You can set case sensitivity with the StrIntlEqN and StrIntlEqNI macros. StrIntlEqN performs a case-sensitive comparison, and StrIntlEqNI performs a case-insensitive comparison.

The syntax of the two macros is:

#define StrIntlEqN(s1, s2, nChar) StrIsIntlEqual(TRUE, s1, s2, nChar)
#define StrIntlEqNI(s1, s2, nChar) StrIsIntlEqual(FALSE, s1, s2, nChar)

Note

The shlwapi.h header defines StrIsIntlEqual as an alias which automatically selects the ANSI or Unicode version of this function based on the definition of the UNICODE preprocessor constant. Mixing usage of the encoding-neutral alias with code that not encoding-neutral can lead to mismatches that result in compilation or runtime errors. For more information, see Conventions for Function Prototypes.

Requirements

Requirement	Value
Minimum supported client	Windows 2000 Professional, Windows XP [desktop apps only]
Minimum supported server	Windows 2000 Server [desktop apps only]
Target Platform	Windows
Header	shlwapi.h
Library	Shlwapi.lib
DLL	Shlwapi.dll (version 4.71 or later)

Share via