Función FindNLSString (winnls.h)

Artículo
08/27/2023

Busca una cadena Unicode (caracteres anchos) o su equivalente en otra cadena Unicode para una configuración regional especificada por el identificador.

Precaución Dado que las cadenas con representaciones binarias muy diferentes pueden compararse como idénticas, esta función puede generar ciertos problemas de seguridad. Para obtener más información, vea la explicación de las funciones de comparación en Consideraciones de seguridad: Características internacionales.

Nota Por motivos de interoperabilidad, la aplicación debe preferir la función FindNLSStringEx porque Microsoft está migrando hacia el uso de nombres de configuración regional en lugar de identificadores de configuración regional para las nuevas configuraciones regionales. Aunque FindNLSString admite configuraciones regionales personalizadas, la mayoría de las aplicaciones deben usar FindNLSStringEx para este tipo de compatibilidad.

Sintaxis

int FindNLSString(
  [in]            LCID    Locale,
  [in]            DWORD   dwFindNLSStringFlags,
  [in]            LPCWSTR lpStringSource,
  [in]            int     cchSource,
  [in]            LPCWSTR lpStringValue,
  [in]            int     cchValue,
  [out, optional] LPINT   pcchFound
);

Parámetros

[in] Locale

Identificador de configuración regional que especifica la configuración regional. Puede usar la macro MAKELCID para crear un identificador o usar uno de los siguientes valores predefinidos.

Windows Vista y versiones posteriores: También se admiten los siguientes identificadores de configuración regional personalizados.

[in] dwFindNLSStringFlags

Marcas que especifican los detalles de la operación de búsqueda. Para obtener definiciones detalladas, consulte el parámetro dwFindNLSStringFlags de FindNLSStringEx.

[in] lpStringSource

Puntero a la cadena de origen, en la que la función busca la cadena especificada por lpStringValue.

[in] cchSource

Tamaño, en caracteres que excluyen el carácter nulo de terminación, de la cadena indicada por lpStringSource. La aplicación no puede especificar 0 o ningún número negativo distinto de -1 para este parámetro. La aplicación especifica -1 si la cadena de origen termina en null y la función debe calcular el tamaño automáticamente.

[in] lpStringValue

Puntero a la cadena de búsqueda, para la que la función busca en la cadena de origen.

[in] cchValue

Tamaño, en caracteres que excluyen el carácter nulo de terminación, de la cadena indicada por lpStringValue. La aplicación no puede especificar 0 o ningún número negativo distinto de -1 para este parámetro. La aplicación especifica -1 si la cadena de búsqueda termina en null y la función debe calcular el tamaño automáticamente.

[out, optional] pcchFound

Puntero a un búfer que contiene la longitud de la cadena que encuentra la función. Para obtener más información, consulte el parámetro pcchFound de FindNLSStringEx.

Valor devuelto

Devuelve un índice basado en 0 en la cadena de origen indicada por lpStringSource si se ejecuta correctamente. En combinación con el valor de pcchFound, este índice proporciona la ubicación exacta de toda la cadena encontrada en la cadena de origen. Un valor devuelto de 0 es un índice sin errores en la cadena de origen y la cadena coincidente está en la cadena de origen en el desplazamiento 0.

La función devuelve -1 si no se realiza correctamente. Para obtener información de error extendida, la aplicación puede llamar a GetLastError, que puede devolver uno de los siguientes códigos de error:

ERROR_INVALID_FLAGS. Los valores proporcionados para las marcas no eran válidos.
ERROR_INVALID_PARAMETER. Cualquiera de los valores de parámetro no era válido.
ERROR_SUCCESS. La acción se completó correctamente, pero no produjo ningún resultado.

Comentarios

Vea Comentarios para FindNLSStringEx.

Requisitos

Requisito	Value
Cliente mínimo compatible	Windows Vista [solo aplicaciones de escritorio]
Servidor mínimo compatible	Windows Server 2008 [solo aplicaciones de escritorio]
Plataforma de destino	Windows
Encabezado	winnls.h (incluya Windows.h)
Library	Kernel32.lib
Archivo DLL	Kernel32.dll