Función RtlStringCchCopyUnicodeStringEx (ntstrsafe.h)
La función RtlStringCchCopyUnicodeStringEx copia el contenido de una estructura de UNICODE_STRING en un destino especificado.
Sintaxis
NTSTRSAFEDDI RtlStringCchCopyUnicodeStringEx(
[out] NTSTRSAFE_PWSTR pszDest,
[in] size_t cchDest,
[in] PCUNICODE_STRING SourceString,
[out] NTSTRSAFE_PWSTR *ppszDestEnd,
[out, optional] size_t *pcchRemaining,
[in] DWORD dwFlags
);
Parámetros
[out] pszDest
Opcional. Puntero a un búfer que recibe la cadena copiada. La cadena a la que apunta la estructura UNICODE_STRING del parámetro SourceString se copia en el búfer en pszDest y termina con un carácter nulo. Este puntero puede ser NULL, pero solo si STRSAFE_IGNORE_NULLS está establecido en dwFlags.
[in] cchDest
Tamaño, en caracteres, del búfer de destino. El búfer debe ser lo suficientemente grande como para la cadena y el carácter nulo de terminación. El número máximo de caracteres del búfer es NTSTRSAFE_MAX_CCH.
[in] SourceString
Opcional. Puntero a una estructura UNICODE_STRING que contiene la cadena que se va a copiar. El número máximo de caracteres de la cadena es NTSTRSAFE_UNICODE_STRING_MAX_CCH. Este puntero puede ser NULL, pero solo si STRSAFE_IGNORE_NULLS está establecido en dwFlags.
[out] ppszDestEnd
Opcional. 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] pcchRemaining
Opcional. 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 sin usar que están en el búfer al que pszDest apunta, 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, el puntero de origen o destino, o ambos, puede ser NULL. RtlStringCchCopyUnicodeStringEx trata punteros de búfer de origen NULL como cadenas vacías (TEXT("")), que se pueden copiar. Los punteros de búfer de destino 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:
|
Valor devuelto
RtlStringCchCopyUnicodeStringEx devuelve uno de los siguientes valores NTSTATUS.
| Código devuelto | Descripción |
|---|---|
| STATUS_SUCCESS | Este estado de éxito significa que los datos de origen se encontraban presentes, la cadena se copió sin truncamiento y el búfer de destino resultante terminó 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 STRSAFE_NO_TRUNCATION se establece en dwFlags, el búfer de destino no se modifica. Si no se establece la marca, el búfer de destino contiene una versión truncada de la cadena copiada. |
| 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 la lista siguiente. |
RtlStringCchCopyUnicodeStringEx devuelve el valor STATUS_INVALID_PARAMETER cuando se produce una de las siguientes acciones:
- El contenido de la estructura UNICODE_STRING no es válido.
- Se especifica una marca no válida en dwFlags.
- El valor de cchDest es mayor que el tamaño máximo del búfer.
- El búfer de destino (al que pszDest apunta) ya está lleno.
- Un puntero de búfer es NULL y no se especifica la marca STRSAFE_IGNORE_NULLS.
- El puntero del búfer de destino es NULL, pero el tamaño del búfer no es cero.
- El puntero del búfer de destino es NULL o su longitud es cero, pero existe una cadena de origen de longitud distinta de cero.
Para obtener información sobre cómo probar valores NTSTATUS, vea Uso de valores NTSTATUS.
Comentarios
La función RtlStringCchCopyUnicodeStringEx usa el tamaño del búfer de destino (que especifica el parámetro cchDest ) para asegurarse de que la operación de copia no escribe más allá del final del búfer.
RtlStringCchCopyUnicodeStringEx agrega a la funcionalidad de la función RtlStringCchCopyUnicodeString devolviendo un puntero al final de la cadena de destino y el número de bytes que quedan sin usar en esa cadena. Puede pasar marcas a la función para un control adicional.
Si las cadenas de origen y destino se superponen, el comportamiento de la función no está definido.
Los punteros *SourceString *y pszDest no pueden ser NULL a menos que la marca STRSAFE_IGNORE_NULLS esté establecida en dwFlags. Si se establece STRSAFE_IGNORE_NULLS, uno o ambos puntos pueden ser NULL. Si el puntero pszDest es NULL, el puntero SourceString debe ser NULL o la estructura UNICODE_STRING debe describir 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 | Si las cadenas que se manipulan siempre residen en la memoria, de lo contrario, PASSIVE_LEVEL |