RtlCopyString routine

The RtlCopyString routine copies a source string to a destination string.

Syntax


VOID RtlCopyString(
  _Out_          PSTRING DestinationString,
  _In_opt_ const STRING  *SourceString
);

Parameters

DestinationString [out]

A pointer to the destination string buffer.

SourceString [in, optional]

A pointer to the source string buffer.

Return value

None

Remarks

The DestinationString Length is set to zero if no source string is supplied. The MaximumLength and Buffer members of the DestinationString are not modified by this routine.

The number of bytes copied from the SourceString is either the length of SourceString or the maximum length of DestinationString, whichever is smaller.

The DestinationString and SourceString buffers must be resident if the caller is running at IRQL >= DISPATCH_LEVEL.

Requirements

Target platform

Universal

Version

Available starting with Windows 2000.

Header

Ntddk.h (include Ntddk.h or Ntifs.h)

Library

NtosKrnl.lib

DLL

NtosKrnl.exe

IRQL

Any level (See Remarks section)

See also

RtlCopyUnicodeString

 

 

Send comments about this topic to Microsoft

Show: