StrTrimA function (shlwapi.h)

Article
02/22/2024

Removes specified leading and trailing characters from a string.

Syntax

BOOL StrTrimA(
  [in, out] PSTR  psz,
  [in]      PCSTR pszTrimChars
);

Parameters

[in, out] psz

Type: PTSTR

A pointer to the null-terminated string to be trimmed. When this function returns successfully, psz receives the trimmed string.

[in] pszTrimChars

Type: PCTSTR

A pointer to a null-terminated string that contains the characters to trim from psz.

Return value

Type: BOOL

TRUE if any characters were removed; otherwise, FALSE.

Remarks

Note

The shlwapi.h header defines StrTrim as an alias that 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 is 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