strcspn, wcscspn, _mbscspn, _mbscspn_l

Artigo
06/09/2015

Retorna o índice da primeira ocorrência em uma cadeia de caracteres, de um caractere que pertence a um conjunto de caracteres.

Importante

_mbschr e _mbschr_lnão podem ser usados em aplicativos executados no Tempo de Execução do Windows.Para obter mais informações, consulte Funções CRT sem suporte pelo /ZW.

size_t strcspn(
   const char *str,
   const char *strCharSet 
);
size_t wcscspn(
   const wchar_t *str,
   const wchar_t *strCharSet 
);
size_t _mbscspn(
   const unsigned char *str,
   const unsigned char *strCharSet 
);
size_t _mbscspn_l(
   const unsigned char *str,
   const unsigned char *strCharSet,
   _locale_t locale
);

Parâmetros

str
Cadeia de caracteres pesquisada terminada com Null.
strCharSet
Conjunto de caracteres terminados em nulo.
locale
Localidade a ser usada.

Valor de retorno

Essas funções retornam o índice do primeiro caractere em str que está em strCharSet. Se nenhum dos caracteres em str estiver em strCharSet, o valor de retorno terá o comprimento de str.

Nenhum valor de retorno é reservado para indicar um erro.

Comentários

wcscspn e _mbscspn são versões de caracteres largos e de multibyte de strcspn. Os argumentos de wcscspn são cadeias de caracteres largos; desses _mbscspn são cadeias de caracteres de multibyte.

_mbscspn valida seus parâmetros. Se str ou strCharSet for um ponteiro nulo, o parâmetro de manipulador inválido será chamado, como descrito em Validação do parâmetro. Se a execução puder continuar, a função retornará 0 e definirá errno como EINVAL. strcspn e wcscspn não validam seus parâmetros. Essas três funções se comportam de forma idêntica.

O valor de saída é afetado pela configuração da categoria LC_CTYPE de localidade. Para obter mais informações, consulte setlocale. As versões dessas funções sem o sufixo _l usam a localidade atual para esse comportamento dependente da localidade; as versões com o sufixo _l são idênticas, exceto que elas usam o parâmetro de localidade informado. Para obter mais informações, consulte Localidade.

Mapeamentos da rotina de texto genérico

Rotina TCHAR.H	_UNICODE & _MBCS não definido	_MBCS definido	_UNICODE definido
_tcscspn	strcspn	_mbscspn	wcscspn
n/a	n/a	_mbscspn_l	n/a

Requisitos

Rotina	Cabeçalho necessário
strcspn	<string.h>
wcscspn	<string.h> ou <wchar.h>
_mbscspn, _mbscspn_l	<mbstring.h>

Para informações adicionais de compatibilidade, consulte Compatibilidade.

Exemplo

// crt_strcspn.c

#include <string.h>
#include <stdio.h>

void test( const char * str, const char * strCharSet )
{
   int pos = strcspn( str, strCharSet );
   printf( "strcspn( \"%s\", \"%s\" ) = %d\n", str, strCharSet, pos );    
}

int main( void )
{
   test( "xyzbxz", "abc" );
   test( "xyzbxz", "xyz" );
   test( "xyzbxz", "no match" );
   test( "xyzbxz", "" );
   test( "", "abc" );
   test( "", "" );
}