Función StringCchLengthW (strsafe.h)

  • Artículo

Determina si una cadena supera la longitud especificada, en caracteres.

StringCchLength es un reemplazo de las siguientes funciones:

Sintaxis

STRSAFEAPI StringCchLengthW(
  [in]  STRSAFE_PCNZWCH psz,
  [in]  size_t          cchMax,
  [out] size_t          *pcchLength
);

Parámetros

[in] psz

Tipo: LPCTSTR

Cadena cuya longitud se va a comprobar.

[in] cchMax

Tipo: size_t

Número máximo de caracteres permitidos en psz, incluido el carácter nulo de terminación. Este valor no puede superar STRSAFE_MAX_CCH.

[out] pcchLength

Tipo: size_t*

Número de caracteres en psz, no incluido el carácter nulo de terminación. Este valor solo es válido si pcch no es NULL y la función se realiza correctamente.

Valor devuelto

Tipo: HRESULT

Esta función puede devolver uno de los valores siguientes. Se recomienda encarecidamente usar las macros SUCCEEDED y FAILED para probar el valor devuelto de esta función.

Código devuelto Descripción
S_OK
 La cadena de psz no era NULL y la longitud de la cadena (incluido el carácter nulo de terminación) es menor o igual que los caracteres cchMax .
STRSAFE_E_INVALID_PARAMETER
 El valor de psz es NULL, cchMax es mayor que STRSAFE_MAX_CCH o psz es mayor que cchMax.
 

Tenga en cuenta que esta función devuelve un valor HRESULT , a diferencia de las funciones que reemplaza.

Comentarios

En comparación con las funciones que reemplaza, StringCchLength es una herramienta adicional para el control adecuado del búfer en el código. El control deficiente del búfer está implicado en muchos problemas de seguridad que implican saturaciones del búfer.

StringCchLength se puede usar en su forma genérica o en sus formularios más específicos. El tipo de datos de la cadena determina la forma de esta función que debe usar.

String (Tipo de datos) Literal de cadena Función
char "cadena" StringCchLengthA
TCHAR TEXT("string") StringCchLength
WCHAR L"string" StringCchLengthW
 

UnalignedStringCchLength es un alias para esta función.

Nota

El encabezado strsafe.h define StringCchLength como alias que selecciona automáticamente la versión ANSI o Unicode de esta función en función de la definición de la constante de preprocesador UNICODE. La combinación del uso del alias neutral de codificación con código que no es neutral de codificación puede dar lugar a errores de coincidencia que dan lugar a errores de compilación o tiempo de ejecución. Para obtener más información, vea Convenciones para prototipos de función.

Requisitos

Requisito Value
Cliente mínimo compatible Windows XP con SP2 [aplicaciones de escritorio | Aplicaciones para UWP]
Servidor mínimo compatible Windows Server 2003 con SP1 [aplicaciones de escritorio | Aplicaciones para UWP]
Plataforma de destino Windows
Encabezado strsafe.h

Consulte también

StringCbLength