Función RtlStringCbCatNExW (ntstrsafe.h)

Artículo
07/16/2024

Las funciones de RtlStringCbCatNExW y RtlStringCbCatNExA concatenan dos cadenas contadas por bytes al limitar el tamaño de la cadena anexada.

Sintaxis

NTSTRSAFEDDI RtlStringCbCatNExW(
  [in, out, optional] NTSTRSAFE_PWSTR pszDest,
  [in]                size_t          cbDest,
  [in, optional]      STRSAFE_PCNZWCH pszSrc,
                      size_t          cbToAppend,
  [out, optional]     NTSTRSAFE_PWSTR *ppszDestEnd,
  [out, optional]     size_t          *pcbRemaining,
  [in]                DWORD           dwFlags
);

Parámetros

[in, out, optional] pszDest

Puntero a un búfer que, en la entrada, contiene una cadena terminada en null a la que se concatenará pszSrc. En la salida, este es el búfer de destino que contiene toda la cadena resultante. La cadena de pszSrc, hasta cbMaxAppend bytes, se agrega al final de la cadena en pszDesty finaliza con un carácter nulo. El puntero pszDest de puede ser NULL, pero solo si STRSAFE_IGNORE_NULLS se establece en dwFlags.

[in] cbDest

Tamaño del búfer de destino, en bytes. El búfer debe ser lo suficientemente grande como para incluir cadenas y el carácter nulo de terminación.

En el caso de las cadenas Unicode, el número máximo de bytes es NTSTRSAFE_MAX_CCH * sizeof(WCHAR)

En el caso de las cadenas ANSI, el número máximo de bytes es NTSTRSAFE_MAX_CCH * sizeof(char)

Si pszDest es NULL, cbDest debe ser cero.

[in, optional] pszSrc

Puntero a una cadena terminada en null. Esta cadena se concatenará al final de la cadena contenida en el búfer en pszDest. El puntero pszSrc de puede ser NULL, pero solo si STRSAFE_IGNORE_NULLS está establecido en dwFlags.

cbToAppend

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

[out, optional] ppszDestEnd

Si el autor de la llamada proporciona un puntero de dirección que no esNULL, después de que se complete la operación de concatenación, la función carga esa dirección con un puntero al búfer de destino resultante terminador de cadena NULL.

[out, optional] pcbRemaining

Si el autor de la llamada proporciona un puntero de dirección NULL que no es deNULL, la función carga la dirección con el número de bytes no usados que están en el búfer al que apunta pszDest, incluidos los bytes usados para el carácter nulo de terminación.

[in] dwFlags

Una o varias marcas y, opcionalmente, un byte de relleno. Las marcas se definen de la siguiente manera:

Valor	Significado
STRSAFE_FILL_BEHIND_NULL	Si se establece esta marca y la función se ejecuta correctamente, se usa el byte bajo de dwFlags para rellenar la parte del búfer de destino que sigue al carácter nulo de terminación.
STRSAFE_IGNORE_NULLS	Si se establece esta marca, pszDest o pszSrc, o ambas, puede ser NULL. punterospszSrc null se tratan como cadenas vacías (TEXT("")), que se pueden copiar. punterospszDest NULL no pueden recibir cadenas no vacías.
STRSAFE_FILL_ON_FAILURE	Si se establece esta marca y se produce un error en la función, se usa el byte bajo de dwFlags para rellenar todo el búfer de destino y el búfer termina en null. Esta operación sobrescribe el contenido del búfer preexistente.
STRSAFE_NULL_ON_FAILURE	Si se establece esta marca y se produce un error en la función, el búfer de destino se establece en una cadena vacía (TEXT("")). Esta operación sobrescribe el contenido del búfer preexistente.
STRSAFE_NO_TRUNCATION	Si se establece esta marca y la función devuelve STATUS_BUFFER_OVERFLOW: Si también se especifica STRSAFE_FILL_ON_FAILURE, STRSAFE_NO_TRUNCATION rellena el búfer de destino en consecuencia. De lo contrario, el búfer de destino no se modificará.

Valor devuelto

La función devuelve uno de los valores NTSTATUS que se enumeran en la tabla siguiente. Para obtener información sobre cómo probar valores NTSTATUS, vea Using NTSTATUS Values.

Código devuelto	Descripción
STATUS_SUCCESS	Este correcto estado significa que los datos de origen estaban presentes, las cadenas se concatenaron completamente sin truncamiento y el búfer de destino resultante está terminado en null.
STATUS_BUFFER_OVERFLOW	Esta advertencia estado significa que la operación de copia no se completó debido a un espacio insuficiente en el búfer de destino. Si se establece STRSAFE_NO_TRUNCATION, consulte el parámetro dwFlags para obtener más información.
STATUS_INVALID_PARAMETER	Este error estado significa que la función recibió un parámetro de entrada no válido. Para obtener más información, consulte el párrafo siguiente. La función devuelve el valor de STATUS_INVALID_PARAMETER cuando: Se especificó una marca no válida. El valor de cbDest es mayor que el tamaño máximo del búfer. El búfer de destino ya estaba lleno. Hay un puntero NULL sin la marca STRSAFE_IGNORE_NULLS. El puntero del búfer de destino se NULL, pero el tamaño del búfer no era cero. El puntero del búfer de destino se NULL, o su longitud era cero, pero había una cadena de origen de longitud distinta de cero.

Código devuelto

Descripción

STATUS_SUCCESS

Este correcto estado significa que los datos de origen estaban presentes, las cadenas se concatenaron completamente sin truncamiento y el búfer de destino resultante está terminado en null.

STATUS_BUFFER_OVERFLOW

Esta advertencia estado significa que la operación de copia no se completó debido a un espacio insuficiente en el búfer de destino. Si se establece STRSAFE_NO_TRUNCATION, consulte el parámetro dwFlags para obtener más información.

STATUS_INVALID_PARAMETER

Este error estado significa que la función recibió un parámetro de entrada no válido. Para obtener más información, consulte el párrafo siguiente.

La función devuelve el valor de STATUS_INVALID_PARAMETER cuando:

Se especificó una marca no válida.
El valor de cbDest es mayor que el tamaño máximo del búfer.
El búfer de destino ya estaba lleno.
Hay un puntero NULL sin la marca STRSAFE_IGNORE_NULLS.
El puntero del búfer de destino se NULL, pero el tamaño del búfer no era cero.
El puntero del búfer de destino se NULL, o su longitud era cero, pero había una cadena de origen de longitud distinta de cero.

Observaciones

rtlStringCbCatNExW y RtlStringCbCatNExA deben usarse en lugar de las funciones siguientes:

strncat
wcsncat

El tamaño, en bytes, del búfer de destino se proporciona a rtlStringCbCatNExW y RtlStringCbCatNExA para asegurarse de que no escriben más allá del final del búfer.

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

Use RtlStringCbCatNExW para controlar cadenas Unicode y rtlStringCbCatNExA para controlar cadenas ANSI. El formulario que use depende de los datos, como se muestra en la tabla siguiente.

Tipo de datos string	Literal de cadena	Función
WCHAR	L"string"	RtlStringCbCatNExW
char	"string"	RtlStringCbCatNExA

Si pszSrc y pszDest apuntan a cadenas superpuestas, el comportamiento de la función no está definido.

Ni pszSrc ni pszDest pueden ser NULL a menos que se establezca la marca STRSAFE_IGNORE_NULLS, en cuyo caso o ambos pueden ser NULL. Si pszDest es NULL, pszSrc debe ser null o apuntar a una cadena vacía.

Para obtener más información sobre las funciones de cadena segura, consulte Uso de funciones de cadena seguras.

Requisitos

Requisito	Valor
cliente mínimo admitido	Disponible en Windows XP con Service Pack 1 (SP1) y versiones posteriores de Windows.
de la plataforma de destino de	Escritorio
encabezado de	ntstrsafe.h (incluya Ntstrsafe.h)
biblioteca de	Ntstrsafe.lib
irQL	Si las cadenas que se manipulan siempre residen en la memoria, de lo contrario, PASSIVE_LEVEL

Consulte también

rtlStringCbCatEx de
RtlStringCbCatN
rtlStringCchCatNEx

Compartir a través de