StrCSpnA function (shlwapi.h)

Article
02/22/2024

Searches a string for the first occurrence of any of a group of characters. The search method is case-sensitive, and the terminating NULL character is included within the search pattern match.

Syntax

int StrCSpnA(
  [in] PCSTR pszStr,
  [in] PCSTR pszSet
);

Parameters

[in] pszStr

Type: PCTSTR

A pointer to the null-terminated string to be searched.

[in] pszSet

Type: PCTSTR

A pointer to a null-terminated string that contains the characters to search for.

Return value

Type: int

Returns the index of the first occurrence in pszStr of any character from pszSet, or the length of pszStr if no match is found.

Remarks

The return value of this function is equal to the length of the initial substring in pszStr that does not include any characters from pszSet.

Note

The shlwapi.h header defines StrCSpn 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