Función StringCbCatNExA (strsafe.h)

Artículo
11/20/2024

Concatena el número especificado de bytes 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.

StringCbCatNEx es un reemplazo de las funciones siguientes:

stringCbCatNEx agrega a la funcionalidad de StringCbCatN devolviendo un puntero al final de la cadena de destino, así como el número de bytes que quedan sin usar en esa cadena. También se pueden pasar marcas a la función para un control adicional.

Sintaxis

STRSAFEAPI StringCbCatNExA(
  [in, out]       STRSAFE_LPSTR  pszDest,
  [in]            size_t         cbDest,
  [in]            STRSAFE_PCNZCH pszSrc,
  [in]            size_t         cbToAppend,
  [out, optional] STRSAFE_LPSTR  *ppszDestEnd,
  [out, optional] size_t         *pcbRemaining,
  [in]            DWORD          dwFlags
);

Parámetros

[in, out] pszDest

Tipo: LPTSTR de

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

[in] cbDest

Tipo: size_t

Tamaño del búfer de destino, en bytes. Este valor debe tener en cuenta la longitud de pszSrc más la longitud de pszDest más los bytes usados para el carácter nulo de terminación. El número máximo de bytes permitido es STRSAFE_MAX_CCH * sizeof(TCHAR).

[in] pszSrc

Tipo: LPCTSTR de

Cadena de origen que se va a concatenar al final de pszDest. Esta cadena debe terminar en null.

[in] cbToAppend

Tipo: size_t

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

[out, optional] ppszDestEnd

Tipo: LPTSTR*

Dirección de un puntero al final de pszDest. Si ppszDestEnd no esNULL 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] pcbRemaining

Tipo: size_t*

Número de bytes no usados en pszDest, incluidos los usados para el carácter nulo de terminación. Si pcbRemaining es NULL, el recuento no se mantiene ni devuelve.

[in] dwFlags

Tipo: DWORD de

Uno o varios de los siguientes valores.

Valor	Significado
STRSAFE_FILL_BEHIND_NULL 0x00000200	Si la función se ejecuta correctamente, se usa el byte bajo de dwFlags (0) para rellenar la parte no inicializada de pszDest después del carácter nulo de terminación.
STRSAFE_IGNORE_NULLS 0x00000100	Trate null punteros de cadena como cadenas vacías (TEXT("")).
STRSAFE_FILL_ON_FAILURE 0x00000400	Si se produce un error en la función, se usa el byte bajo de dwFlags (0) para rellenar todo el búfer de 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 siguientes valores. 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 está terminado en null.
STRSAFE_E_INVALID_PARAMETER	El valor de cbDest es mayor que `STRSAFE_MAX_CCH * sizeof(TCHAR)`, se pasó una marca no válida o hay discrepancias entre el tamaño del pszDest, cbDesty 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 y 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 de HRESULT, a diferencia de las funciones que reemplaza.

Observaciones

En comparación con las funciones que reemplaza, stringCbCatNEx proporciona 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 de búfer. StringCbCatNEx siempre finaliza 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 superposición.

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

StringCbCatNEx 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 se debe usar.

Tipo de datos de cadena	Literal de cadena	Función
char	"string"	StringCbCatNExA
TCHAR	TEXT("string")	StringCbCatNEx
WCHAR	L"string"	StringCbCatNExW

Nota

El encabezado strsafe.h define StringCbCatNEx 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 Conventions for Function Prototypes.

Requisitos

Requisito	Valor
cliente mínimo admitido	Windows XP con SP2 [aplicaciones de escritorio \| Aplicaciones para UWP]
servidor mínimo admitido	Windows Server 2003 con SP1 [aplicaciones de escritorio \| Aplicaciones para UWP]
de la plataforma de destino de	Windows
encabezado de	strsafe.h

Consulte también

de referencia de

StringCbCatEx

StringCbCatN

StringCchCatNEx

Compartir a través de