Sergey Pastor / 1

Important changes to repositories hosted on mbed.com

Mbed hosted mercurial repositories are deprecated and are due to be permanently deleted in July 2026.

To keep a copy of this software download the repository Zip archive or clone locally using Mercurial.

It is also possible to export all your personal repositories from the account settings page.

Dependents:   Nucleo

Embed: (wiki syntax)

« Back to documentation index

str.h File Reference
Functions

str.h File Reference

String manipulation helper functions. More...

Go to the source code of this file.

Functions

char_t * strDuplicate (const char_t *s)
 Duplicate a string.
char_t * strTrimWhitespace (char_t *s)
 Removes all leading and trailing whitespace from a string.
void strRemoveTrailingSpace (char_t *s)
 Removes all trailing whitespace from a string.
void strReplaceChar (char_t *s, char_t oldChar, char_t newChar)
 Replace all occurrences of the specified character.
error_t strSafeCopy (char_t *dest, const char_t *src, size_t destSize)
 Copy string.

Detailed Description

String manipulation helper functions.

License

Copyright (C) 2010-2017 Oryx Embedded SARL. All rights reserved.

This program is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 2 of the License, or (at your option) any later version.

This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.

You should have received a copy of the GNU General Public License along with this program; if not, write to the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.

Author:
Oryx Embedded SARL (www.oryx-embedded.com)
Version:
1.7.6

Definition in file str.h.

Function Documentation

char_t* strDuplicate ( const char_t *  s )

Duplicate a string.

Parameters:
[in]sPointer to a constant NULL-terminated character string
Returns:
Address of the string that was copied, or NULL if the string cannot be copied

Definition at line 40 of file str.c.

void strRemoveTrailingSpace ( char_t *  s )

Removes all trailing whitespace from a string.

Parameters:
[in,out]sPointer to a NULL-terminated character string

Definition at line 102 of file str.c.

void strReplaceChar ( char_t *  s,
char_t  oldChar,
char_t  newChar 
)

Replace all occurrences of the specified character.

Parameters:
[in,out]sPointer to a NULL-terminated character string
[in]oldCharThe character to be replaced
[in]newCharThe character that will replace all occurrences of oldChar

Definition at line 128 of file str.c.

error_t strSafeCopy ( char_t *  dest,
const char_t *  src,
size_t  destSize 
)

Copy string.

Parameters:
[out]destPointer to the destination string
[in]srcPointer to the source string
[in]destSizeSize of the buffer allocated for the destination string
Returns:
Error code

Definition at line 148 of file str.c.

char_t* strTrimWhitespace ( char_t *  s )

Removes all leading and trailing whitespace from a string.

Parameters:
[in]sThe string that will be trimmed
Returns:
String with whitespace stripped from the beginning and end

Definition at line 68 of file str.c.

Generated on Tue Jul 12 2022 17:10:22 by  doxygen 1.7.2