Función RtlStringCchCatNExW (ntstrsafe.h)

  • Artículo

Las funciones RtlStringCchCatNExW y RtlStringCchCatNExA concatenan dos cadenas con recuento de caracteres al limitar el tamaño de la cadena anexada.

Sintaxis

NTSTRSAFEDDI RtlStringCchCatNExW(
  [in, out, optional] NTSTRSAFE_PWSTR pszDest,
  [in]                size_t          cchDest,
  [in, optional]      STRSAFE_PCNZWCH pszSrc,
                      size_t          cchToAppend,
  [out, optional]     NTSTRSAFE_PWSTR *ppszDestEnd,
  [out, optional]     size_t          *pcchRemaining,
  [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 en pszSrc, hasta caracteres cchMaxAppend , se agrega al final de la cadena en pszDest y termina con un carácter nulo. El puntero pszDest puede ser NULL, pero solo si STRSAFE_IGNORE_NULLS está establecido en dwFlags.

[in] cchDest

Tamaño del búfer de destino, en caracteres. El número máximo de caracteres permitido es NTSTRSAFE_MAX_CCH. Si pszDest es NULL, cchDest debe ser cero.

[in, optional] pszSrc

Un 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 puede ser NULL, pero solo si STRSAFE_IGNORE_NULLS está establecido en dwFlags.

cchToAppend

Número máximo de caracteres que se van a anexar a la cadena contenida en el búfer en pszDest.

[out, optional] ppszDestEnd

Si el autor de la llamada proporciona un puntero de dirección distinto de NULL , una vez completada la operación de concatenación, la función carga esa dirección con un puntero al terminador de cadena null resultante del búfer de destino.

[out, optional] pcchRemaining

Si el autor de la llamada proporciona un puntero de dirección distinto de NULL , la función carga la dirección con el número de caracteres no usadas en el búfer al que apunta pszDest, incluido 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, el byte bajo de dwFlags se usa 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. Los punteros null pszSrc se tratan como cadenas vacías (TEXT("")), que se pueden copiar. Los punteros pszDest 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, el byte bajo de dwFlags se usa para rellenar todo el búfer de destino y el búfer termina en null. Esta operación sobrescribe cualquier contenido de 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 cualquier contenido de 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 Uso de valores NTSTATUS.

Código devuelto Descripción
STATUS_SUCCESS Este estado correcto significa que los datos de origen están presentes, la cadena de salida se creó sin truncamiento y el búfer de destino resultante termina en null.
STATUS_BUFFER_OVERFLOW Este estado de advertencia significa que la operación 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 estado de error significa que la función recibió un parámetro de entrada no válido. Para obtener más información, vea el siguiente párrafo.

La función devuelve el valor STATUS_INVALID_PARAMETER cuando:

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

Comentarios

RtlStringCchCatNExW y RtlStringCchCatNExA deben usarse en lugar de las siguientes funciones:

  • strncat
  • wcsncat

El tamaño, en caracteres, del búfer de destino se proporciona a RtlStringCchCatNExW y RtlStringCchCatNExA para asegurarse de que las funciones no escriben más allá del final del búfer.

RtlStringCchCatNExW y RtlStringCchCatNExA agregan a la funcionalidad de RtlStringCchCatN devolviendo un puntero al final de la cadena de destino, así como el número de caracteres que no se usan en esa cadena. Las marcas se pueden pasar a la función para un control adicional.

Use RtlStringCchCatNExW para controlar cadenas Unicode y RtlStringCchCatNExA 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" RtlStringCchCatNExW
char "cadena" RtlStringCchCatNExA

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 Value
Cliente mínimo compatible Disponible en Windows XP con Service Pack 1 (SP1) y versiones posteriores de Windows.
Plataforma de destino Escritorio
Encabezado ntstrsafe.h (incluya Ntstrsafe.h)
Library Ntstrsafe.lib
IRQL PASSIVE_LEVEL

Consulte también