Condividi tramite

Funzione RtlStringCbCopyUnicodeStringEx (ntstrsafe.h)

  • Articolo

La funzione RtlStringCbCopyUnicodeStringEx copia il contenuto di una struttura UNICODE_STRING in una destinazione specificata.

Sintassi

NTSTRSAFEDDI RtlStringCbCopyUnicodeStringEx(
  [out]           NTSTRSAFE_PWSTR  pszDest,
  [in]            size_t           cbDest,
  [in]            PCUNICODE_STRING SourceString,
  [out]           NTSTRSAFE_PWSTR  *ppszDestEnd,
  [out, optional] size_t           *pcbRemaining,
  [in]            DWORD            dwFlags
);

Parametri

[out] pszDest

Opzionale. Puntatore a un buffer che riceve la stringa copiata. La stringa a cui punta la struttura di UNICODE_STRING del parametro SourceString viene copiata nel buffer in pszDest e terminata con un carattere Null. Questo puntatore può essere NULL, ma solo se STRSAFE_IGNORE_NULLS è impostato in dwFlags.

[in] cbDest

Dimensioni, in byte, del buffer di destinazione. Il buffer deve essere sufficientemente grande per la stringa e il carattere null di terminazione. Il numero massimo di byte nel buffer è NTSTRSAFE_MAX_CCH * sizeof(WCHAR).

[in] SourceString

Opzionale. Puntatore a una struttura UNICODE_STRING che contiene la stringa da copiare. Il numero massimo di byte nella stringa è NTSTRSAFE_UNICODE_STRING_MAX_CCH * sizeof(WCHAR). Questo puntatore può essere NULL, ma solo se STRSAFE_IGNORE_NULLS è impostato in dwFlags.

[out] ppszDestEnd

Opzionale. Se il chiamante fornisce un puntatore nullNULL, al termine dell'operazione di copia, la funzione carica tale indirizzo con un puntatore al buffer di destinazione NULL terminatore di stringa.

[out, optional] pcbRemaining

Opzionale. Se il chiamante fornisce un puntatoreNULL non, la funzione carica l'indirizzo con il numero di byte inutilizzati presenti nel buffer che pszDest punta, inclusi i byte utilizzati per il carattere Null di terminazione.

[in] dwFlags

Uno o più flag e, facoltativamente, un byte di riempimento. I flag sono definiti come segue:

Valore Significato
STRSAFE_FILL_BEHIND_NULL Se questo flag è impostato e la funzione ha esito positivo, viene usato il byte basso di dwFlags per riempire la parte del buffer di destinazione che segue il carattere Null di terminazione.
STRSAFE_IGNORE_NULLS Se questo flag è impostato, il puntatore di origine o di destinazione o entrambi può essere NULL. RtlStringCbCopyUnicodeStringEx considera NULL puntatori al buffer di origine come stringhe vuote (TEXT("")), che possono essere copiate. i puntatori del buffer di destinazione null non possono ricevere stringhe non vuoti.
STRSAFE_FILL_ON_FAILURE Se questo flag è impostato e la funzione ha esito negativo, viene usato il byte basso di dwFlags per riempire l'intero buffer di destinazione e il buffer viene terminato con null. Questa operazione sovrascrive qualsiasi contenuto preesistente del buffer.
STRSAFE_NULL_ON_FAILURE Se questo flag è impostato e la funzione ha esito negativo, il buffer di destinazione viene impostato su una stringa vuota (TEXT("")). Questa operazione sovrascrive qualsiasi contenuto preesistente del buffer.
STRSAFE_NO_TRUNCATION

Se questo flag è impostato e la funzione restituisce STATUS_BUFFER_OVERFLOW:

  • Se viene specificato anche STRSAFE_FILL_ON_FAILURE, STRSAFE_NO_TRUNCATION riempie di conseguenza il buffer di destinazione.
  • In caso contrario, il contenuto del buffer di destinazione verrà impostato su una stringa vuota, anche se STRSAFE_NULL_ON_FAILURE non è impostato. STRSAFE_FILL_BEHIND_NULL viene ignorato.

Valore restituito

RtlStringCbCopyUnicodeStringEx restituisce uno dei valori NTSTATUS seguenti.

Codice restituito Descrizione
STATUS_SUCCESS Questo esito positivo stato indica che i dati di origine erano presenti, la stringa è stata copiata senza troncamento e il buffer di destinazione risultante viene terminato con null.
STATUS_BUFFER_OVERFLOW Questo avviso stato indica che l'operazione di copia non è stata completata a causa di spazio insufficiente nel buffer di destinazione. Se STRSAFE_NO_TRUNCATION è impostato in dwFlags, il buffer di destinazione non viene modificato. Se il flag non è impostato, il buffer di destinazione contiene una versione troncata della stringa copiata.
STATUS_INVALID_PARAMETER Questo errore stato indica che la funzione ha ricevuto un parametro di input non valido. Per altre informazioni, vedere l'elenco seguente.

RtlStringCbCopyUnicodeStringEx restituisce il valore STATUS_INVALID_PARAMETER quando si verifica una delle condizioni seguenti:

  • Il contenuto della struttura di UNICODE_STRING non è valido.
  • Un flag non valido viene specificato in dwFlags.
  • Il valore in cbDest è maggiore della dimensione massima del buffer.
  • Il buffer di destinazione (che pszDest punta a) è già pieno.
  • Un puntatore al buffer è NULL e il flag di STRSAFE_IGNORE_NULLS non è specificato.
  • Il puntatore del buffer di destinazione è NULL, ma la dimensione del buffer non è zero.
  • Il puntatore del buffer di destinazione è null o la relativa lunghezza è zero, ma è presente una stringa di origine di lunghezza diversa da zero.

Per informazioni su come testare i valori NTSTATUS, vedere Uso di valori NTSTATUS.

Osservazioni

La funzione RtlStringCbCopyUnicodeStringEx usa le dimensioni del buffer di destinazione (che il parametro cbDest specifica) per assicurarsi che l'operazione di copia non scriva oltre la fine del buffer.

RtlStringCbCopyUnicodeStringEx aggiunge alla funzionalità della funzione RtlStringCbCopyUnicodeString restituendo un puntatore alla fine della stringa di destinazione e il numero di byte rimasti inutilizzati in tale stringa. È possibile passare flag alla funzione per un controllo aggiuntivo.

Se le stringhe di origine e di destinazione si sovrappongono, il comportamento della funzione non è definito.

I puntatori *SourceString *e pszDest non possono essere null a meno che il flag STRSAFE_IGNORE_NULLS non sia impostato in dwFlags. Se STRSAFE_IGNORE_NULLS è impostato, uno o entrambi questi puntatori possono essere NULL. Se il puntatore pszDest è NULL, il puntatore *SourceString *deve essere NULL o la struttura UNICODE_STRING deve descrivere una stringa vuota.

Per altre informazioni sulle funzioni della stringa sicura, vedere Uso di funzioni stringa sicure.

Fabbisogno

Requisito Valore
client minimo supportato Disponibile in Windows XP con Service Pack 1 (SP1) e versioni successive di Windows.
piattaforma di destinazione Desktop
intestazione ntstrsafe.h (include Ntstrsafe.h)
libreria Ntstrsafe.lib
IRQL Qualsiasi se le stringhe modificate sono sempre residenti in memoria, altrimenti PASSIVE_LEVEL

Vedere anche