lstrcpyA

関数

ANSI文字列を別バッファへ複写する。

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

シグネチャ

// KERNEL32.dll  (ANSI / -A)
#include <windows.h>

LPSTR lstrcpyA(
    LPSTR lpString1,
    LPCSTR lpString2
);

パラメーター

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

戻り値の型: LPSTR

公式ドキュメント

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

戻り値

型: LPTSTR

関数が成功した場合、戻り値はバッファへのポインターです。

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

解説(Remarks)

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

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

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

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

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

バッファオーバーフローはアプリケーションにおける多くのセキュリティ問題の原因であり、アクセス違反が発生した場合にはアプリケーションに対するサービス拒否攻撃を引き起こす可能性があります。最悪の場合、特に 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  (ANSI / -A)
#include <windows.h>

LPSTR lstrcpyA(
    LPSTR lpString1,
    LPCSTR lpString2
);

[DllImport("KERNEL32.dll", CharSet = CharSet.Ansi, ExactSpelling = true)]
static extern IntPtr lstrcpyA(
    [MarshalAs(UnmanagedType.LPStr)] System.Text.StringBuilder lpString1,   // LPSTR out
    [MarshalAs(UnmanagedType.LPStr)] string lpString2   // LPCSTR
);

<DllImport("KERNEL32.dll", CharSet:=CharSet.Ansi, ExactSpelling:=True)>
Public Shared Function lstrcpyA(
    <MarshalAs(UnmanagedType.LPStr)> lpString1 As System.Text.StringBuilder,   ' LPSTR out
    <MarshalAs(UnmanagedType.LPStr)> lpString2 As String   ' LPCSTR
) As IntPtr
End Function

' lpString1 : LPSTR out
' lpString2 : LPCSTR
Declare PtrSafe Function lstrcpyA Lib "kernel32" ( _
    ByVal lpString1 As String, _
    ByVal lpString2 As String) As LongPtr
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。

import ctypes
from ctypes import wintypes

lstrcpyA = ctypes.windll.kernel32.lstrcpyA
lstrcpyA.restype = wintypes.LPSTR
lstrcpyA.argtypes = [
    wintypes.LPSTR,  # lpString1 : LPSTR out
    wintypes.LPCSTR,  # lpString2 : LPCSTR
]

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('KERNEL32.dll')
lstrcpyA = Fiddle::Function.new(
  lib['lstrcpyA'],
  [
    Fiddle::TYPE_VOIDP,  # lpString1 : LPSTR out
    Fiddle::TYPE_VOIDP,  # lpString2 : LPCSTR
  ],
  Fiddle::TYPE_VOIDP)

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

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

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

出力引数:

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