Función StringCbCatExA (strsafe.h)
Concatena 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.
stringCbCatEx agrega a la funcionalidad de stringCbCat 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.
StringCbCatEx es un reemplazo de las funciones siguientes:
- strcat, wcscat, _tcsat
- lstrcat
- StrCat
-
de
StrCatBuff
Sintaxis
STRSAFEAPI StringCbCatExA(
[in, out] STRSAFE_LPSTR pszDest,
[in] size_t cbDest,
[in] STRSAFE_LPCSTR pszSrc,
[out, optional] STRSAFE_LPSTR *ppszDestEnd,
[out, optional] size_t *pcbRemaining,
[in] DWORD dwFlags
);
Parámetros
[in, out] pszDest
Tipo: LPTSTR de
Cadena a la que se va a concatenar pszSrc y que 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 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 concatenada al final de pszDest. Esta cadena debe terminar en null.
[out, optional] ppszDestEnd
Tipo:
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 |
|---|---|
|
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. |
|
Trate null punteros de cadena como cadenas vacías (TEXT("")). Esta marca es útil para simular funciones como lstrcpy. |
|
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. |
|
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. |
|
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 |
|---|---|
|
Los datos de origen estaban presentes, las cadenas estaban totalmente concatenadas sin truncamiento y el búfer de destino resultante está terminado en null. |
|
El valor de cbDest es menor que sizeof(TCHAR) o mayor que el valor máximo permitido.
|
|
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
stringCbCatEx 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. StringCbCatEx 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.
StringCbCatEx 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, como se muestra en la tabla siguiente.
| Tipo de datos de cadena | Literal de cadena | Función |
|---|---|---|
| char | "string" | StringCbCatExA |
| TCHAR | TEXT("string") | StringCbCatEx |
| WCHAR | L"string" | StringCbCatExW |
Nota
El encabezado strsafe.h define StringCbCatEx 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
stringCchCatEx de