lstrcpynW

関数

ワイド文字列を最大長指定で複写する。

DLLKERNEL32.dll文字セットUnicode (-W)呼出規約winapi対応OSWindows 2000 以降

シグネチャ

// KERNEL32.dll  (Unicode / -W)
#include <windows.h>

LPWSTR lstrcpynW(
    LPWSTR lpString1,
    LPCWSTR lpString2,
    INT iMaxLength
);

パラメーター

名前	型	方向	説明
lpString1	LPWSTR	out	コピーされた文字を受け取る宛先バッファです。このバッファは、終端の null 文字分の領域を含め、iMaxLength で指定された数の TCHAR 値を格納できる十分な大きさが必要です。
lpString2	LPCWSTR	in	関数が文字をコピーする元となるソース文字列です。
iMaxLength	INT	in	lpString2 が指す文字列から lpString1 が指すバッファへコピーする TCHAR 値の数で、終端の null 文字を含みます。

戻り値の型: LPWSTR

公式ドキュメント

指定した数の文字をソース文字列からバッファにコピーします。警告使用しないでください。(Unicode)

戻り値

型: LPTSTR

関数が成功した場合、戻り値はバッファへのポインターです。ソース文字列が iMaxLength 文字より長い場合でも、この関数は成功することがあります。

関数が失敗した場合、戻り値は NULL となり、lpString1 は null 終端されていない可能性があります。

解説(Remarks)

lpString1 が指すバッファは、終端の null 文字を格納できる十分な大きさが必要であり、iMaxLength で指定する文字列長の値には終端の null 文字分の領域が含まれます。

lstrcpyn 関数は、ソースバッファと宛先バッファが重なっている場合の動作が未定義です。

セキュリティ上の警告

この関数を誤って使用すると、アプリケーションのセキュリティが損なわれる可能性があります。この関数は、アクセス違反などのエラーを捕捉するために構造化例外処理 (SEH) を使用します。この関数が SEH エラーを捕捉すると、文字列を null 終端せず、また呼び出し元にエラーを通知することもなく NULL を返します。呼び出し元は、領域不足がエラーの原因であると安全に想定することはできません。

lpString1 が指すバッファがコピーされる文字列を格納するのに十分な大きさでない場合、バッファオーバーランが発生する可能性があります。文字列全体をコピーする際は、sizeof がバイト数を返すことに注意してください。たとえば、lpString1 が TCHAR szString[100] として宣言されたバッファ szString1 を指す場合、sizeof(szString1) はバッファのサイズを WCHAR 単位ではなくバイト単位で返すため、この関数の Unicode 版ではバッファオーバーフローにつながる可能性があります。

バッファオーバーフローはアプリケーションにおける多くのセキュリティ問題の原因であり、アクセス違反が発生した場合にはアプリケーションに対するサービス拒否攻撃を引き起こすおそれがあります。最悪の場合、特に lpString1 がスタックベースのバッファであるとき、バッファオーバーランによって攻撃者がプロセスに実行可能コードを注入できるようになる可能性があります。

sizeof(szString1)/sizeof(szString1[0]) を使用すると、バッファの正しいサイズが得られます。

代わりに StringCchCopy の使用を検討してください。StringCchCopy(buffer, sizeof(buffer)/sizeof(buffer[0]), src); を使用する場合は buffer がポインターであってはならないことに注意し、または StringCchCopy(buffer, ARRAYSIZE(buffer), src); を使用する場合は、ポインターへコピーする際に呼び出し元が指し示すメモリのサイズを文字単位で渡す責任を負うことに注意してください。

続行する前にセキュリティに関する考慮事項: Windows ユーザーインターフェイスを確認してください。

メモ

winbase.h ヘッダーは、UNICODE プリプロセッサ定数の定義に基づいて、この関数の ANSI 版または Unicode 版を自動的に選択するエイリアスとして lstrcpyn を定義しています。エンコーディング非依存のエイリアスの使用と、エンコーディング非依存ではないコードを混在させると、不一致が生じ、コンパイルエラーや実行時エラーを引き起こす可能性があります。詳細については、関数プロトタイプの規則を参照してください。

出典・ライセンス: 上記「公式ドキュメント」の内容は Microsoft の Win32 API ドキュメント(MicrosoftDocs/sdk-api)を日本語に翻訳・改変したものです。© Microsoft Corporation. CC BY 4.0 で提供。
Microsoft 公式リファレンス: 英語 (en-us) · 日本語 (ja-jp) · 原文ソース (GitHub)

各言語での呼び出し定義

// KERNEL32.dll  (Unicode / -W)
#include <windows.h>

LPWSTR lstrcpynW(
    LPWSTR lpString1,
    LPCWSTR lpString2,
    INT iMaxLength
);

[DllImport("KERNEL32.dll", CharSet = CharSet.Unicode, ExactSpelling = true)]
static extern IntPtr lstrcpynW(
    [MarshalAs(UnmanagedType.LPWStr)] System.Text.StringBuilder lpString1,   // LPWSTR out
    [MarshalAs(UnmanagedType.LPWStr)] string lpString2,   // LPCWSTR
    int iMaxLength   // INT
);

<DllImport("KERNEL32.dll", CharSet:=CharSet.Unicode, ExactSpelling:=True)>
Public Shared Function lstrcpynW(
    <MarshalAs(UnmanagedType.LPWStr)> lpString1 As System.Text.StringBuilder,   ' LPWSTR out
    <MarshalAs(UnmanagedType.LPWStr)> lpString2 As String,   ' LPCWSTR
    iMaxLength As Integer   ' INT
) As IntPtr
End Function

' lpString1 : LPWSTR out
' lpString2 : LPCWSTR
' iMaxLength : INT
Declare PtrSafe Function lstrcpynW Lib "kernel32" ( _
    ByVal lpString1 As LongPtr, _
    ByVal lpString2 As LongPtr, _
    ByVal iMaxLength As Long) As LongPtr
' Unicode(W): 文字列は ByVal As LongPtr とし StrPtr(unicodeStr) を渡す
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。

import ctypes
from ctypes import wintypes

lstrcpynW = ctypes.windll.kernel32.lstrcpynW
lstrcpynW.restype = wintypes.LPWSTR
lstrcpynW.argtypes = [
    wintypes.LPWSTR,  # lpString1 : LPWSTR out
    wintypes.LPCWSTR,  # lpString2 : LPCWSTR
    ctypes.c_int,  # iMaxLength : INT
]

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('KERNEL32.dll')
lstrcpynW = Fiddle::Function.new(
  lib['lstrcpynW'],
  [
    Fiddle::TYPE_VOIDP,  # lpString1 : LPWSTR out
    Fiddle::TYPE_VOIDP,  # lpString2 : LPCWSTR
    Fiddle::TYPE_INT,  # iMaxLength : INT
  ],
  Fiddle::TYPE_VOIDP)
# Wide strings: pass str.encode("UTF-16LE") + "\x00\x00"

#[link(name = "kernel32")]
extern "system" {
    fn lstrcpynW(
        lpString1: *mut u16,  // LPWSTR out
        lpString2: *const u16,  // LPCWSTR
        iMaxLength: i32  // INT
    ) -> *mut u16;
}
// crates: windows-sys provides ready-made bindings for this API.

$sig = @"
[DllImport("KERNEL32.dll", CharSet = CharSet.Unicode)]
public static extern IntPtr lstrcpynW([MarshalAs(UnmanagedType.LPWStr)] System.Text.StringBuilder lpString1, [MarshalAs(UnmanagedType.LPWStr)] string lpString2, int iMaxLength);
"@
$api = Add-Type -MemberDefinition $sig -Name 'KERNEL32_lstrcpynW' -Namespace Win32 -PassThru
# $api::lstrcpynW(lpString1, lpString2, iMaxLength)

#uselib "KERNEL32.dll"
#func global lstrcpynW "lstrcpynW" wptr, wptr, wptr
; lstrcpynW varptr(lpString1), lpString2, iMaxLength   ; 戻り値は stat
; lpString1 : LPWSTR out -> "wptr"
; lpString2 : LPCWSTR -> "wptr"
; iMaxLength : INT -> "wptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。

出力引数:

#uselib "KERNEL32.dll"
#cfunc global lstrcpynW "lstrcpynW" var, wstr, int
; res = lstrcpynW(lpString1, lpString2, iMaxLength)
; lpString1 : LPWSTR out -> "var"
; lpString2 : LPCWSTR -> "wstr"
; iMaxLength : INT -> "int"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。#uselib "KERNEL32.dll"
#cfunc global lstrcpynW "lstrcpynW" sptr, wstr, int
; res = lstrcpynW(varptr(lpString1), lpString2, iMaxLength)
; lpString1 : LPWSTR out -> "sptr"
; lpString2 : LPCWSTR -> "wstr"
; iMaxLength : INT -> "int"
; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは varptr(変数))。