lstrcpyW

関数

ワイド文字列を別バッファへ複写する。

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

シグネチャ

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

LPWSTR lstrcpyW(
    LPWSTR lpString1,
    LPCWSTR lpString2
);

パラメーター

名前	型	方向	説明
lpString1	LPWSTR	out	lpString2 パラメーターが指す文字列の内容を受け取るバッファです。バッファは、終端の null 文字を含めて、文字列全体を格納できる十分な大きさである必要があります。
lpString2	LPCWSTR	in	コピーする null 終端文字列です。

戻り値の型: LPWSTR

公式ドキュメント

文字列をバッファにコピーします。(Unicode)

戻り値

型: LPTSTR

関数が成功すると、戻り値はバッファへのポインターになります。

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

解説(Remarks)

システムのダブルバイト文字セット (DBCS) バージョンでは、この関数を使用して DBCS 文字列をコピーできます。

lstrcpy 関数は、コピー元とコピー先のバッファが重なっている場合、動作が未定義になります。

セキュリティに関する注意

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

lpString1 は、lpString2 と終端の '\0' を格納できる十分な大きさである必要があります。そうでない場合、バッファオーバーランが発生する可能性があります。

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

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

メモ

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

出典・ライセンス: 上記「公式ドキュメント」の内容は 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 lstrcpyW(
    LPWSTR lpString1,
    LPCWSTR lpString2
);

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

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

' lpString1 : LPWSTR out
' lpString2 : LPCWSTR
Declare PtrSafe Function lstrcpyW Lib "kernel32" ( _
    ByVal lpString1 As LongPtr, _
    ByVal lpString2 As LongPtr) 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

lstrcpyW = ctypes.windll.kernel32.lstrcpyW
lstrcpyW.restype = wintypes.LPWSTR
lstrcpyW.argtypes = [
    wintypes.LPWSTR,  # lpString1 : LPWSTR out
    wintypes.LPCWSTR,  # lpString2 : LPCWSTR
]

require 'fiddle'
require 'fiddle/import'

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

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

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

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

出力引数:

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