Función RtlStringCbCopyExW (ntstrsafe.h)

  • Artículo

Las funciones RtlStringCbCopyExW y RtlStringCbCopyExA copian una cadena con recuento de bytes en un búfer.

Sintaxis

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

Parámetros

[out, optional] pszDest

Puntero a un búfer proporcionado por el autor de la llamada que recibe la cadena copiada. La cadena de pszSrc se copia en el búfer en pszDest y termina con un carácter null. El puntero pszDest puede ser NULL, pero solo si STRSAFE_IGNORE_NULLS se establece en dwFlags.

[in] cbDest

Tamaño, en bytes, del búfer de destino. El búfer debe ser lo suficientemente grande para la cadena como para 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 proporcionada por el autor de la llamada y terminada en null. El puntero pszSrc puede ser NULL, pero solo si STRSAFE_IGNORE_NULLS se establece en dwFlags.

[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 copia, la función carga esa dirección con un puntero al terminador de cadena NULL resultante del búfer de destino.

[out, optional] pcbRemaining

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 bytes no usados a los 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 realiza 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, pueden ser NULL. Los punteros pszSrcNULL se tratan como cadenas vacías (TEXT("")), que se pueden copiar. Los punteros pszDestNULL 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 contenido del búfer de destino se establecerá en una cadena vacía, incluso si no se establece STRSAFE_NULL_ON_FAILURE . STRSAFE_FILL_BEHIND_NULL se omite.

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 se copió sin truncamiento y el búfer de destino resultante termina en null.
STATUS_BUFFER_OVERFLOW Este estado de advertencia 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 estado de error 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 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.
  • 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

Se debe usar RtlStringCbCopyExA y RtlStringCbCopyExW en lugar de las siguientes funciones:

  • strcpy
  • wcscpy

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

RtlStringCbCopyEx agrega a la funcionalidad de RtlStringCbCopy devolviendo un puntero al final de la cadena de destino, así como el 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 RtlStringCbCopyExW para controlar cadenas Unicode y RtlStringCbCopyExA 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" RtlStringCbCopyExW
char "cadena" RtlStringCbCopyExA

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