Função RtlStringCchCopyExA (ntstrsafe.h)

  • Artigo

As funções RtlStringCchCopyExW e RtlStringCchCopyExA copiam uma cadeia de caracteres contada em um buffer.

Sintaxe

NTSTRSAFEDDI RtlStringCchCopyExA(
  [out, optional] NTSTRSAFE_PSTR  pszDest,
  [in]            size_t          cchDest,
  [in, optional]  NTSTRSAFE_PCSTR pszSrc,
  [out, optional] NTSTRSAFE_PSTR  *ppszDestEnd,
  [out, optional] size_t          *pcchRemaining,
  [in]            DWORD           dwFlags
);

Parâmetros

[out, optional] pszDest

Um ponteiro para um buffer fornecido pelo chamador que recebe a cadeia de caracteres copiada. A cadeia de caracteres em pszSrc é copiada para o buffer em pszDest e terminada com um caractere nulo. O ponteiro pszDest pode ser NULL, mas somente se STRSAFE_IGNORE_NULLS estiver definido em dwFlags.

[in] cchDest

O tamanho do buffer de destino, em caracteres. O número máximo de caracteres permitido é NTSTRSAFE_MAX_CCH. Se pszDest for NULL, cchDest deverá ser zero.

[in, optional] pszSrc

Um ponteiro para uma cadeia de caracteres com terminação nula fornecida pelo chamador. O ponteiro pszSrc pode ser NULL, mas somente se STRSAFE_IGNORE_NULLS estiver definido em dwFlags.

[out, optional] ppszDestEnd

Se o chamador fornecer um ponteiro de endereço não NULL , depois que a operação de cópia for concluída, a função carregará esse endereço com um ponteiro para o terminador de cadeia de caracteres nula resultante do buffer de destino.

[out, optional] pcchRemaining

Se o chamador fornecer um ponteiro de endereço não NULL , a função carregará o endereço com o número de caracteres não utilizados que estão no buffer apontado por pszDest, incluindo o caractere nulo de terminação.

[in] dwFlags

Um ou mais sinalizadores e, opcionalmente, um byte de preenchimento. Os sinalizadores são definidos da seguinte maneira:

Valor Significado
STRSAFE_FILL_BEHIND_NULL Se esse sinalizador for definido e a função for bem-sucedida, o byte baixo de dwFlags será usado para preencher a parte do buffer de destino que segue o caractere nulo de terminação.
STRSAFE_IGNORE_NULLS Se esse sinalizador estiver definido, pszDest ou pszSrc, ou ambos, poderão ser NULL. Os ponteiros null pszSrc são tratados como cadeias de caracteres vazias (TEXT("")), que podem ser copiadas. Os ponteiros null pszDest não podem receber cadeias de caracteres não vazias.
STRSAFE_FILL_ON_FAILURE Se esse sinalizador for definido e a função falhar, o byte baixo de dwFlags será usado para preencher todo o buffer de destino e o buffer será encerrado em nulo. Essa operação substitui qualquer conteúdo de buffer pré-existente.
STRSAFE_NULL_ON_FAILURE Se esse sinalizador for definido e a função falhar, o buffer de destino será definido como uma cadeia de caracteres vazia (TEXT("")). Essa operação substitui qualquer conteúdo de buffer pré-existente.
STRSAFE_NO_TRUNCATION

Se esse sinalizador estiver definido e a função retornar STATUS_BUFFER_OVERFLOW:

  • Se STRSAFE_FILL_ON_FAILURE também for especificado, STRSAFE_NO_TRUNCATION preencherá o buffer de destino adequadamente.
  • Caso contrário, o conteúdo do buffer de destino será definido como uma cadeia de caracteres vazia, mesmo que STRSAFE_NULL_ON_FAILURE não esteja definido. STRSAFE_FILL_BEHIND_NULL é ignorado.

Retornar valor

A função retorna um dos valores NTSTATUS listados na tabela a seguir. Para obter informações sobre como testar valores NTSTATUS, consulte Usando valores NTSTATUS.

Código de retorno Descrição
STATUS_SUCCESS Esse êxito status significa que os dados de origem estavam presentes, a cadeia de caracteres foi copiada sem truncamento e o buffer de destino resultante foi encerrado em nulo.
STATUS_BUFFER_OVERFLOW Esse aviso status significa que a operação de cópia não foi concluída devido a espaço insuficiente no buffer de destino. Se STRSAFE_NO_TRUNCATION estiver definido em dwFlags, consulte o parâmetro dwFlags para obter mais informações.
STATUS_INVALID_PARAMETER

Esse erro status significa que a função recebeu um parâmetro de entrada inválido. Para obter mais informações, consulte o parágrafo a seguir.

A função retorna o valor STATUS_INVALID_PARAMETER quando:

  • Um sinalizador inválido foi especificado.
  • O valor em cchDest é maior que o tamanho máximo do buffer.
  • O buffer de destino já estava cheio.
  • Um ponteiro **NULL** estava presente sem o sinalizador STRSAFE_IGNORE_NULLS .
  • O ponteiro do buffer de destino era **NULL**, mas o tamanho do buffer não era zero.
  • O ponteiro do buffer de destino era **NULL**, ou seu comprimento era zero, mas uma cadeia de caracteres de origem de comprimento diferente de zero estava presente.

Comentários

RtlStringCchCopyExW e RtlStringCchCopyExA devem ser usados em vez das seguintes funções:

  • strcpy
  • wcscpy

O tamanho, em caracteres, do buffer de destino é fornecido a RtlStringCchCopyExW e RtlStringCchCopyExA para garantir que eles não escrevam após o final do buffer.

RtlStringCchCopyExW e RtlStringCchCopyExA adicionam à funcionalidade de RtlStringCchCopy retornando um ponteiro para o final da cadeia de caracteres de destino, bem como o número de caracteres não utilizados nessa cadeia de caracteres. Os sinalizadores podem ser passados para a função para controle adicional. Use RtlStringCchCopyExW para manipular cadeias de caracteres Unicode e RtlStringCchCopyExA para manipular cadeias de caracteres ANSI. O formulário usado depende de seus dados, conforme mostrado na tabela a seguir.

Tipos de dados de cadeia de caracteres Cadeia de caracteres literal Função
WCHAR L"string" RtlStringCchCopyExW
char “cadeia de caracteres” RtlStringCchCopyExA

Se pszSrc e pszDest apontarem para cadeias de caracteres sobrepostas, o comportamento da função será indefinido.

Nem pszSrc nem pszDest podem ser NULL , a menos que o sinalizador STRSAFE_IGNORE_NULLS esteja definido; nesse caso, ou ambos podem ser NULL. Se pszDest for NULL, pszSrc deverá ser NULL ou apontar para uma cadeia de caracteres vazia.

Para obter mais informações sobre as funções de cadeia de caracteres seguras, consulte Usando funções de cadeia de caracteres seguras.

Requisitos

Requisito Valor
Cliente mínimo com suporte Disponível no Windows XP com Service Pack 1 (SP1) e versões posteriores do Windows.
Plataforma de Destino Área de Trabalho
Cabeçalho ntstrsafe.h (inclua Ntstrsafe.h)
Biblioteca Ntstrsafe.lib
IRQL PASSIVE_LEVEL

Confira também