__crtLCMapStringW

Mapeia uma cadeia de caracteres para outra, executando a transformação dependente de localidade especificada. Essa função também pode ser usada para gerar uma chave de classificação para a cadeia de caracteres de entrada.

Sintaxe

int __crtLCMapStringW(
   LCID    Locale,
   DWORD   dwMapFlags,
   LPCWSTR lpSrcStr,
   int     cchSrc,
   LPWSTR  lpDestStr,
   int     cchDest)

Parâmetros

Locale
O identificador de localidade. A localidade fornece um contexto para o mapeamento de cadeia de caracteres ou a geração de chaves de classificação. Um aplicativo pode usar a macro MAKELCID para criar um identificador de localidade.

dwMapFlags
O tipo de transformação a ser usado durante o mapeamento da cadeia de caracteres ou a geração da chave de classificação.

lpSrcStr
Ponteiro para uma cadeia de caracteres de origem que a função mapeia ou usa para geração de chave de classificação. Esse parâmetro é considerado uma cadeia de caracteres Unicode.

cchSrc
Tamanho, em caracteres, da cadeia de caracteres apontada pelo parâmetro lpSrcStr. Essa contagem pode incluir ou não o terminador nulo.

Um valor cchSrc de -1 especifica que a cadeia de caracteres apontada por lpSrcStr é terminada em nulo. Nesse caso, e essa função estiver sendo usada em seu modo de mapeamento de string, a função calcula o comprimento da string em si e termina em nulo a string mapeada armazenada em *lpDestStr.

lpDestStr
Ponteiro longo para um buffer em que a função armazena a cadeia de caracteres ou chave de classificação mapeada.

cchDest
Tamanho, em caracteres, do buffer apontado por lpDestStr.

Valor retornado

Se o valor de cchDest for diferente de zero, o número de caracteres, ou bytes, se LCMAP_SORTKEY for especificado, gravados no buffer indica êxito. Essa contagem inclui espaço para um terminador nulo.

Se o valor de cchDest for zero, o tamanho do buffer em caracteres, ou bytes, se LCMAP_SORTKEY for especificado, necessário para receber a cadeia de caracteres ou chave de classificação traduzida indica êxito. Esse tamanho inclui espaço para um terminador nulo.

Zero indica uma falha. Para obter outras informações sobre o erro, chame a função GetLastError.

Comentários

Se cchSrc for maior que zero e lpSrcStr for uma cadeia de caracteres terminada em nulo, __crtLCMapStringW define cchSrc para o comprimento da cadeia de caracteres. Em seguida, __crtLCMapStringW chama a versão de cadeia de caracteres larga (Unicode) da função LCMapString com os parâmetros especificados. Para obter mais informações sobre os parâmetros e o valor retornado dessa função, consulte o LCMapString.

Requisitos

Rotina	Cabeçalho necessário
__crtLCMapStringW	<awint.h>