Condividi tramite

Funzione RtlUnicodeStringCbCatNEx (ntstrsafe.h)

  • Articolo

La funzione RtlUnicodeStringCbCatNEx concatena due stringhe contenute in strutture UNICODE_STRING limitando le dimensioni della stringa copiata.

Sintassi

NTSTRSAFEDDI RtlUnicodeStringCbCatNEx(
  [in, out]       PUNICODE_STRING  DestinationString,
  [in]            PCUNICODE_STRING SourceString,
  [in]            size_t           cbToAppend,
  [out, optional] PUNICODE_STRING  RemainingString,
  [in]            DWORD            dwFlags
);

Parametri

[in, out] DestinationString

Facoltativo. Puntatore a una struttura UNICODE_STRING . Questa struttura include un buffer che, in input, contiene una stringa di destinazione a cui verrà concatenata la stringa di origine. Nell'output, questo buffer è il buffer di destinazione che contiene l'intera stringa risultante. La stringa di origine viene aggiunta alla fine della stringa di destinazione. Il numero massimo di byte nel buffer stringa della struttura è NTSTRSAFE_UNICODE_STRING_MAX_CCH * sizeof(WCHAR). DestinationString può essere NULL, ma solo se STRSAFE_IGNORE_NULLS è impostato in dwFlags.

[in] SourceString

facoltativo. Puntatore a una struttura UNICODE_STRING . Questa struttura include un buffer contenente la stringa di origine. Questa stringa verrà aggiunta alla fine della stringa di destinazione. Il numero massimo di byte nel buffer stringa della struttura è NTSTRSAFE_UNICODE_STRING_MAX_CCH * sizeof(WCHAR). SourceString può essere NULL, ma solo se STRSAFE_IGNORE_NULLS è impostato in dwFlags.

[in] cbToAppend

Numero massimo di byte da aggiungere alla stringa descritta dal parametro DestinationString .

[out, optional] RemainingString

facoltativo. Se il chiamante fornisce un puntatore non NULL a una struttura UNICODE_STRING , la funzione imposta il membro Buffer di questa struttura alla fine della stringa concatenata, imposta il membro Length della struttura su zero e imposta il membro MaximumLength della struttura sul numero di byte rimanenti nel buffer di destinazione. RemainingString può essere NULL, ma solo se STRSAFE_IGNORE_NULLS è impostato in dwFlags.

[in] dwFlags

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

Valore Significato
STRSAFE_FILL_BEHIND Se questo flag è impostato e la funzione ha esito positivo, il byte basso di dwFlags viene usato per riempire la parte del buffer di destinazione che segue l'ultimo carattere nella stringa.
STRSAFE_IGNORE_NULLS Se questo flag è impostato, il puntatore di origine o di destinazione o entrambi può essere NULL. RtlUnicodeStringCbCatNEx tratta i puntatori del buffer di origine NULL come stringhe vuote (TEXT("")), che possono essere copiate. I puntatori del buffer di destinazione NULL non possono ricevere stringhe non dispendiose.
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. Questa operazione sovrascrive qualsiasi contenuto del buffer preesistente.
STRSAFE_NULL_ON_FAILURE Se questo flag è impostato e la funzione ha esito negativo, il buffer di destinazione è impostato su una stringa vuota (TEXT(""). Questa operazione sovrascrive qualsiasi contenuto del buffer preesistente.
STRSAFE_NO_TRUNCATION

Se questo flag è impostato e la funzione restituisce STATUS_BUFFER_OVERFLOW:

  • Se STRSAFE_FILL_ON_FAILURE viene specificato anche, STRSAFE_NO_TRUNCATION riempie di conseguenza il buffer di destinazione.
  • In caso contrario, il buffer di destinazione verrà modificato.
STRSAFE_ZERO_LENGTH_ON_FAILURE Se questo flag è impostato e la funzione restituisce STATUS_BUFFER_OVERFLOW, la lunghezza della stringa di destinazione è impostata su zero byte.

Valore restituito

RtlUnicodeStringCbCatNEx restituisce uno dei valori NTSTATUS seguenti.

Codice restituito Descrizione
STATUS_SUCCESS Questo stato di esito positivo indica che i dati di origine erano presenti e le stringhe sono state concatenate senza troncamento.
STATUS_BUFFER_OVERFLOW Questo stato di avviso indica che l'operazione di concatenazione non è stata completata a causa di spazio insufficiente nel buffer di destinazione. Se STRSAFE_NO_TRUNCATION è impostato, vedere il parametro dwFlags per altre informazioni.
STATUS_INVALID_PARAMETER Questo stato di errore indica che la funzione ha ricevuto un parametro di input non valido. Per altre informazioni, vedere l'elenco seguente.

RtlUnicodeStringCbCatNEx restituisce il valore di STATUS_INVALID_PARAMETER quando si verifica uno dei seguenti:

  • Il contenuto di una struttura UNICODE_STRING non è valido.
  • Un flag non valido viene specificato in dwFlags.
  • Il buffer di destinazione è già pieno.
  • Un puntatore del buffer è NULL e il flag di STRSAFE_IGNORE_NULLS non è specificato in dwFlags.
  • 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 non zero.
  • Il valore del parametro cbToAppend è maggiore di NTSTRSAFE_UNICODE_STRING_MAX_CCH * sizeof(WCHAR).

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

Commenti

La funzione RtlUnicodeStringCbCatNEx usa le dimensioni del buffer di destinazione per assicurarsi che l'operazione di concatenazione non venga scritta oltre la fine del buffer. Per impostazione predefinita, la funzione non termina la stringa risultante con un valore di carattere Null, ovvero con zero. Come opzione, il chiamante può usare il flag STRSAFE_FILL_BEHIND e un valore di byte di riempimento pari a zero per terminare una stringa risultante che non occupa l'intero buffer di destinazione.

RtlUnicodeStringCbCatNEx aggiunge alla funzionalità della funzione RtlUnicodeStringCbCatN restituendo una struttura UNICODE_STRING che identifica la fine della stringa di destinazione e il numero di byte lasciati inutilizzati in tale stringa. È possibile passare i flag a RtlUnicodeStringCbCatNEx per un controllo aggiuntivo.

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

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

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

Requisiti

Requisito Valore
Client minimo supportato Disponibile a partire da Windows XP con Service Pack 1 (SP1).
Piattaforma di destinazione Desktop
Intestazione ntstrsafe.h (include Ntstrsafe.h)
Libreria Ntstrsafe.lib
IRQL Qualsiasi se le stringhe modificate sono sempre residenti in memoria, in caso contrario PASSIVE_LEVEL

Vedi anche