lstrcpynA

関数

ANSI文字列を最大長指定で複写する。

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

シグネチャ

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

LPSTR lstrcpynA(
    LPSTR lpString1,
    LPCSTR lpString2,
    INT iMaxLength
);

パラメーター

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

戻り値の型: LPSTR

公式ドキュメント

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

戻り値

型: 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 ヘッダーは lstrcpyn をエイリアスとして定義しており、UNICODE プリプロセッサ定数の定義に基づいて、この関数の ANSI 版または Unicode 版を自動的に選択します。エンコーディング非依存のエイリアスの使用を、エンコーディング非依存でないコードと混在させると、不一致が生じ、コンパイルエラーや実行時エラーを引き起こす可能性があります。詳細については、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 lstrcpynA(
    LPSTR lpString1,
    LPCSTR lpString2,
    INT iMaxLength
);

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

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

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

import ctypes
from ctypes import wintypes

lstrcpynA = ctypes.windll.kernel32.lstrcpynA
lstrcpynA.restype = wintypes.LPSTR
lstrcpynA.argtypes = [
    wintypes.LPSTR,  # lpString1 : LPSTR out
    wintypes.LPCSTR,  # lpString2 : LPCSTR
    ctypes.c_int,  # iMaxLength : INT
]

require 'fiddle'
require 'fiddle/import'

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

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

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

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

出力引数:

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