Función StringCchCatNExW (strsafe.h)

  • Artículo

Concatena el número especificado de caracteres de una cadena a otra. El tamaño del búfer de destino se proporciona a la función para asegurarse de que no escribe más allá del final de este búfer.

StringCchCatNEx agrega a la funcionalidad de StringCchCatN devolviendo un puntero al final de la cadena de destino, así como el número de caracteres que no se usan en esa cadena. También se pueden pasar marcas a la función para un control adicional.

StringCchCatNEx es un reemplazo de las siguientes funciones:

Sintaxis

STRSAFEAPI StringCchCatNExW(
  [in, out]       STRSAFE_LPWSTR  pszDest,
  [in]            size_t          cchDest,
  [in]            STRSAFE_PCNZWCH pszSrc,
  [in]            size_t          cchToAppend,
  [out, optional] STRSAFE_LPWSTR  *ppszDestEnd,
  [out, optional] size_t          *pcchRemaining,
  [in]            DWORD           dwFlags
);

Parámetros

[in, out] pszDest

Tipo: LPTSTR

El búfer de destino, que contiene la cadena que se va a concatenar con pszSrc, y recibirá toda la cadena resultante. La cadena en pszSrc se agrega al final de la cadena en pszDest.

[in] cchDest

Tipo: size_t

Tamaño del búfer de destino, en caracteres. Este valor debe ser igual a la longitud de pszSrc más la longitud de pszDest más 1 para tener en cuenta el carácter nulo de terminación. El número máximo de caracteres permitido es STRSAFE_MAX_CCH.

[in] pszSrc

Tipo: LPCTSTR

Cadena de origen que se concatena al final de pszDest. Esta cadena debe terminar en null.

[in] cchToAppend

Tipo: size_t

Número máximo de caracteres que se van a anexar a pszDest.

[out, optional] ppszDestEnd

Tipo: LPTSTR*

Dirección de un puntero al final de pszDest. Si ppszDestEnd no es NULL y los datos se anexan al búfer de destino, apunta al carácter nulo de terminación al final de la cadena.

[out, optional] pcchRemaining

Tipo: size_t*

Número de caracteres sin usar en pszDest, incluido el carácter nulo de terminación. Si pcchRemaining es NULL, el recuento no se mantiene ni se devuelve.

[in] dwFlags

Tipo: DWORD

Uno o varios de los valores siguientes.

Valor Significado
STRSAFE_FILL_BEHIND_NULL
0x00000200
 Si la función se ejecuta correctamente, el byte bajo de dwFlags (0) se usa para rellenar la parte no inicializada de pszDest después del carácter nulo de terminación.
STRSAFE_IGNORE_NULLS
0x00000100
 Trate punteros de cadena NULL como cadenas vacías (TEXT("")).
STRSAFE_FILL_ON_FAILURE
0x00000400
 Si se produce un error en la función, el byte bajo de dwFlags (0) se usa para rellenar todo el búfer pszDest y el búfer termina en null. En el caso de un error de STRSAFE_E_INSUFFICIENT_BUFFER , se sobrescribe cualquier cadena preexistente o truncada en el búfer de destino.
STRSAFE_NULL_ON_FAILURE
0x00000800
 Si se produce un error en la función, pszDest se establece en una cadena vacía (TEXT("")). En el caso de un error de STRSAFE_E_INSUFFICIENT_BUFFER , se sobrescribe cualquier cadena preexistente o truncada en el búfer de destino.
STRSAFE_NO_TRUNCATION
0x00001000
 Si se produce un error en la función, pszDest no se modifica. No se agrega nada al contenido original.

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
 Los datos de origen estaban presentes, las cadenas se concatenaron sin truncamiento y el búfer de destino resultante terminó en null.
STRSAFE_E_INVALID_PARAMETER
 El valor de cchDest es mayor que STRSAFE_MAX_CCH, se pasó una marca no válida o hay discrepancias entre el tamaño del pszDest, cchDest y la cantidad de material que se va a anexar en pszSrc.
STRSAFE_E_INSUFFICIENT_BUFFER
 Error en la operación de copia debido a un espacio de búfer insuficiente. Según el valor de dwFlags, el búfer de destino puede contener una versión truncada terminada en null del resultado previsto. En situaciones en las que el truncamiento es aceptable, es posible que esto no se vea necesariamente como una condición de error.
 

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, StringCchCatNEx proporciona un procesamiento 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. StringCchCatNEx siempre termina en null y nunca desborda un búfer de destino válido, incluso si el contenido de la cadena de origen cambia durante la operación.

El comportamiento no está definido si las cadenas a las que apunta pszSrc y pszDest se superponen.

Ni pszSrc ni pszDest deben ser NULL a menos que se especifique la marca STRSAFE_IGNORE_NULLS , en cuyo caso ambos pueden ser NULL. Sin embargo, es posible que todavía se devuelva un error debido a un espacio insuficiente aunque se omitan los valores NULL .

StringCchCatNEx 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" StringCchCatNExA
TCHAR TEXT("string") StringCchCatNEx
WCHAR L"string" StringCchCatNExW
 

Nota

El encabezado strsafe.h define StringCchCatNEx 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

Referencia

StringCbCatNEx

StringCchCatEx

StringCchCatN