Win32 API 日本語リファレンス
ホームSystem.Antimalware › AmsiScanString

AmsiScanString

関数
文字列内容をAMSIでマルウェアスキャンする。
DLLAmsi.dll呼出規約winapi対応OSWindows 10 以降

シグネチャ

// Amsi.dll
#include <windows.h>

HRESULT AmsiScanString(
    HAMSICONTEXT amsiContext,
    LPCWSTR string,
    LPCWSTR contentName,   // optional
    HAMSISESSION amsiSession,   // optional
    AMSI_RESULT* result
);

パラメーター

名前方向説明
amsiContextHAMSICONTEXTinスキャンに使うAMSIコンテキストハンドル。
stringLPCWSTRinスキャンする対象文字列を指す広域文字列。
contentNameLPCWSTRinoptionalスキャン対象の名前を示す広域文字列。NULL可。
amsiSessionHAMSISESSIONinoptional関連付けるAMSIセッションハンドル。相関不要なら0(NULL)可。
resultAMSI_RESULT*outスキャン結果を受け取るAMSI_RESULT列挙ポインタ。

戻り値の型: HRESULT

各言語での呼び出し定義

// Amsi.dll
#include <windows.h>

HRESULT AmsiScanString(
    HAMSICONTEXT amsiContext,
    LPCWSTR string,
    LPCWSTR contentName,   // optional
    HAMSISESSION amsiSession,   // optional
    AMSI_RESULT* result
);
[DllImport("Amsi.dll", ExactSpelling = true)]
static extern int AmsiScanString(
    IntPtr amsiContext,   // HAMSICONTEXT
    [MarshalAs(UnmanagedType.LPWStr)] string string,   // LPCWSTR
    [MarshalAs(UnmanagedType.LPWStr)] string contentName,   // LPCWSTR optional
    IntPtr amsiSession,   // HAMSISESSION optional
    out int result   // AMSI_RESULT* out
);
<DllImport("Amsi.dll", ExactSpelling:=True)>
Public Shared Function AmsiScanString(
    amsiContext As IntPtr,   ' HAMSICONTEXT
    <MarshalAs(UnmanagedType.LPWStr)> [string] As String,   ' LPCWSTR
    <MarshalAs(UnmanagedType.LPWStr)> contentName As String,   ' LPCWSTR optional
    amsiSession As IntPtr,   ' HAMSISESSION optional
    <Out> ByRef result As Integer   ' AMSI_RESULT* out
) As Integer
End Function
' amsiContext : HAMSICONTEXT
' string : LPCWSTR
' contentName : LPCWSTR optional
' amsiSession : HAMSISESSION optional
' result : AMSI_RESULT* out
Declare PtrSafe Function AmsiScanString Lib "amsi" ( _
    ByVal amsiContext As LongPtr, _
    ByVal string As LongPtr, _
    ByVal contentName As LongPtr, _
    ByVal amsiSession As LongPtr, _
    ByRef result As Long) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。
import ctypes
from ctypes import wintypes

AmsiScanString = ctypes.windll.amsi.AmsiScanString
AmsiScanString.restype = ctypes.c_int
AmsiScanString.argtypes = [
    wintypes.HANDLE,  # amsiContext : HAMSICONTEXT
    wintypes.LPCWSTR,  # string : LPCWSTR
    wintypes.LPCWSTR,  # contentName : LPCWSTR optional
    wintypes.HANDLE,  # amsiSession : HAMSISESSION optional
    ctypes.c_void_p,  # result : AMSI_RESULT* out
]
require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('Amsi.dll')
AmsiScanString = Fiddle::Function.new(
  lib['AmsiScanString'],
  [
    Fiddle::TYPE_VOIDP,  # amsiContext : HAMSICONTEXT
    Fiddle::TYPE_VOIDP,  # string : LPCWSTR
    Fiddle::TYPE_VOIDP,  # contentName : LPCWSTR optional
    Fiddle::TYPE_VOIDP,  # amsiSession : HAMSISESSION optional
    Fiddle::TYPE_VOIDP,  # result : AMSI_RESULT* out
  ],
  Fiddle::TYPE_INT)
#[link(name = "amsi")]
extern "system" {
    fn AmsiScanString(
        amsiContext: *mut core::ffi::c_void,  // HAMSICONTEXT
        string: *const u16,  // LPCWSTR
        contentName: *const u16,  // LPCWSTR optional
        amsiSession: *mut core::ffi::c_void,  // HAMSISESSION optional
        result: *mut i32  // AMSI_RESULT* out
    ) -> i32;
}
// crates: windows-sys provides ready-made bindings for this API.
$sig = @"
[DllImport("Amsi.dll")]
public static extern int AmsiScanString(IntPtr amsiContext, [MarshalAs(UnmanagedType.LPWStr)] string string, [MarshalAs(UnmanagedType.LPWStr)] string contentName, IntPtr amsiSession, out int result);
"@
$api = Add-Type -MemberDefinition $sig -Name 'Amsi_AmsiScanString' -Namespace Win32 -PassThru
# $api::AmsiScanString(amsiContext, string, contentName, amsiSession, result)
#uselib "Amsi.dll"
#func global AmsiScanString "AmsiScanString" sptr, sptr, sptr, sptr, sptr
; AmsiScanString amsiContext, string, contentName, amsiSession, varptr(result)   ; 戻り値は stat
; amsiContext : HAMSICONTEXT -> "sptr"
; string : LPCWSTR -> "sptr"
; contentName : LPCWSTR optional -> "sptr"
; amsiSession : HAMSISESSION optional -> "sptr"
; result : AMSI_RESULT* out -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
出力引数:
#uselib "Amsi.dll"
#cfunc global AmsiScanString "AmsiScanString" sptr, wstr, wstr, sptr, var
; res = AmsiScanString(amsiContext, string, contentName, amsiSession, result)
; amsiContext : HAMSICONTEXT -> "sptr"
; string : LPCWSTR -> "wstr"
; contentName : LPCWSTR optional -> "wstr"
; amsiSession : HAMSISESSION optional -> "sptr"
; result : AMSI_RESULT* out -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
出力引数:
; HRESULT AmsiScanString(HAMSICONTEXT amsiContext, LPCWSTR string, LPCWSTR contentName, HAMSISESSION amsiSession, AMSI_RESULT* result)
#uselib "Amsi.dll"
#cfunc global AmsiScanString "AmsiScanString" intptr, wstr, wstr, intptr, var
; res = AmsiScanString(amsiContext, string, contentName, amsiSession, result)
; amsiContext : HAMSICONTEXT -> "intptr"
; string : LPCWSTR -> "wstr"
; contentName : LPCWSTR optional -> "wstr"
; amsiSession : HAMSISESSION optional -> "intptr"
; result : AMSI_RESULT* out -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	amsi = windows.NewLazySystemDLL("Amsi.dll")
	procAmsiScanString = amsi.NewProc("AmsiScanString")
)

// amsiContext (HAMSICONTEXT), string (LPCWSTR), contentName (LPCWSTR optional), amsiSession (HAMSISESSION optional), result (AMSI_RESULT* out)
r1, _, err := procAmsiScanString.Call(
	uintptr(amsiContext),
	uintptr(unsafe.Pointer(windows.StringToUTF16Ptr(string))),
	uintptr(unsafe.Pointer(windows.StringToUTF16Ptr(contentName))),
	uintptr(amsiSession),
	uintptr(result),
)
_ = err  // syscall.Errno (valid when the call sets last-error)
_ = r1   // HRESULT
function AmsiScanString(
  amsiContext: THandle;   // HAMSICONTEXT
  string: PWideChar;   // LPCWSTR
  contentName: PWideChar;   // LPCWSTR optional
  amsiSession: THandle;   // HAMSISESSION optional
  result: Pointer   // AMSI_RESULT* out
): Integer; stdcall;
  external 'Amsi.dll' name 'AmsiScanString';
result := DllCall("Amsi\AmsiScanString"
    , "Ptr", amsiContext   ; HAMSICONTEXT
    , "WStr", string   ; LPCWSTR
    , "WStr", contentName   ; LPCWSTR optional
    , "Ptr", amsiSession   ; HAMSISESSION optional
    , "Ptr", result   ; AMSI_RESULT* out
    , "Int")   ; return: HRESULT
●AmsiScanString(amsiContext, string, contentName, amsiSession, result) = DLL("Amsi.dll", "int AmsiScanString(void*, char*, char*, void*, void*)")
# 呼び出し: AmsiScanString(amsiContext, string, contentName, amsiSession, result)
# amsiContext : HAMSICONTEXT -> "void*"
# string : LPCWSTR -> "char*"
# contentName : LPCWSTR optional -> "char*"
# amsiSession : HAMSISESSION optional -> "void*"
# result : AMSI_RESULT* out -> "void*"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。
const std = @import("std");

extern "amsi" fn AmsiScanString(
    amsiContext: ?*anyopaque, // HAMSICONTEXT
    string: [*c]const u16, // LPCWSTR
    contentName: [*c]const u16, // LPCWSTR optional
    amsiSession: ?*anyopaque, // HAMSISESSION optional
    result: [*c]i32 // AMSI_RESULT* out
) callconv(std.os.windows.WINAPI) i32;
proc AmsiScanString(
    amsiContext: pointer,  # HAMSICONTEXT
    string: WideCString,  # LPCWSTR
    contentName: WideCString,  # LPCWSTR optional
    amsiSession: pointer,  # HAMSISESSION optional
    result: ptr int32  # AMSI_RESULT* out
): int32 {.importc: "AmsiScanString", stdcall, dynlib: "Amsi.dll".}
pragma(lib, "amsi");
extern(Windows)
int AmsiScanString(
    void* amsiContext,   // HAMSICONTEXT
    const(wchar)* string,   // LPCWSTR
    const(wchar)* contentName,   // LPCWSTR optional
    void* amsiSession,   // HAMSISESSION optional
    int* result   // AMSI_RESULT* out
);
ccall((:AmsiScanString, "Amsi.dll"), stdcall, Int32,
      (Ptr{Cvoid}, Cwstring, Cwstring, Ptr{Cvoid}, Ptr{Int32}),
      amsiContext, string, contentName, amsiSession, result)
# amsiContext : HAMSICONTEXT -> Ptr{Cvoid}
# string : LPCWSTR -> Cwstring
# contentName : LPCWSTR optional -> Cwstring
# amsiSession : HAMSISESSION optional -> Ptr{Cvoid}
# result : AMSI_RESULT* out -> Ptr{Int32}
# stdcall は 32bit のみ意味を持つ(x64 では無視)。
local ffi = require("ffi")
ffi.cdef[[
int32_t AmsiScanString(
    void* amsiContext,
    const uint16_t* string,
    const uint16_t* contentName,
    void* amsiSession,
    int32_t* result);
]]
local amsi = ffi.load("amsi")
-- amsi.AmsiScanString(amsiContext, string, contentName, amsiSession, result)
-- amsiContext : HAMSICONTEXT
-- string : LPCWSTR
-- contentName : LPCWSTR optional
-- amsiSession : HAMSISESSION optional
-- result : AMSI_RESULT* out
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
const koffi = require('koffi');
const lib = koffi.load('Amsi.dll');
const AmsiScanString = lib.func('__stdcall', 'AmsiScanString', 'int32_t', ['void *', 'str16', 'str16', 'void *', 'int32_t *']);
// AmsiScanString(amsiContext, string, contentName, amsiSession, result)
// amsiContext : HAMSICONTEXT -> 'void *'
// string : LPCWSTR -> 'str16'
// contentName : LPCWSTR optional -> 'str16'
// amsiSession : HAMSISESSION optional -> 'void *'
// result : AMSI_RESULT* out -> 'int32_t *'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。
const lib = Deno.dlopen("Amsi.dll", {
  AmsiScanString: { parameters: ["pointer", "buffer", "buffer", "pointer", "pointer"], result: "i32" },
});
// lib.symbols.AmsiScanString(amsiContext, string, contentName, amsiSession, result)
// amsiContext : HAMSICONTEXT -> "pointer"
// string : LPCWSTR -> "buffer"
// contentName : LPCWSTR optional -> "buffer"
// amsiSession : HAMSISESSION optional -> "pointer"
// result : AMSI_RESULT* out -> "pointer"
// 文字列引数は "buffer"(NUL 終端のバイト列を Uint8Array で渡す)。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。
<?php
$ffi = FFI::cdef(<<<C
int32_t AmsiScanString(
    void* amsiContext,
    const uint16_t* string,
    const uint16_t* contentName,
    void* amsiSession,
    int32_t* result);
C, "Amsi.dll");
// $ffi->AmsiScanString(amsiContext, string, contentName, amsiSession, result);
// amsiContext : HAMSICONTEXT
// string : LPCWSTR
// contentName : LPCWSTR optional
// amsiSession : HAMSISESSION optional
// result : AMSI_RESULT* out
// 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
// WINAPI(stdcall): x64 では呼出規約が統一されるため問題なし。x86 では __stdcall 対応のラッパが必要な場合あり。
import com.sun.jna.*;
import com.sun.jna.ptr.*;
import com.sun.jna.win32.StdCallLibrary;
import com.sun.jna.win32.W32APIOptions;

public interface Amsi extends StdCallLibrary {
    Amsi INSTANCE = Native.load("amsi", Amsi.class);
    int AmsiScanString(
        Pointer amsiContext,   // HAMSICONTEXT
        WString string,   // LPCWSTR
        WString contentName,   // LPCWSTR optional
        Pointer amsiSession,   // HAMSISESSION optional
        IntByReference result   // AMSI_RESULT* out
    );
}
@[Link("amsi")]
lib LibAmsi
  fun AmsiScanString = AmsiScanString(
    amsiContext : Void*,   # HAMSICONTEXT
    string : UInt16*,   # LPCWSTR
    contentName : UInt16*,   # LPCWSTR optional
    amsiSession : Void*,   # HAMSISESSION optional
    result : Int32*   # AMSI_RESULT* out
  ) : Int32
end
# 構造体/GUID/enum は lib 内に対応する型定義が必要。
# 呼出規約: x64 は規約統一のため OK。x86(32bit)は WINAPI=stdcall だが Crystal の fun に stdcall 付与構文がなく非対応。
import 'dart:ffi';
import 'package:ffi/ffi.dart';

typedef AmsiScanStringNative = Int32 Function(Pointer<Void>, Pointer<Utf16>, Pointer<Utf16>, Pointer<Void>, Pointer<Int32>);
typedef AmsiScanStringDart = int Function(Pointer<Void>, Pointer<Utf16>, Pointer<Utf16>, Pointer<Void>, Pointer<Int32>);
final AmsiScanString = DynamicLibrary.open('Amsi.dll')
    .lookupFunction<AmsiScanStringNative, AmsiScanStringDart>('AmsiScanString');
// amsiContext : HAMSICONTEXT -> Pointer<Void>
// string : LPCWSTR -> Pointer<Utf16>
// contentName : LPCWSTR optional -> Pointer<Utf16>
// amsiSession : HAMSISESSION optional -> Pointer<Void>
// result : AMSI_RESULT* out -> Pointer<Int32>
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function AmsiScanString(
  amsiContext: THandle;   // HAMSICONTEXT
  string: PWideChar;   // LPCWSTR
  contentName: PWideChar;   // LPCWSTR optional
  amsiSession: THandle;   // HAMSISESSION optional
  result: Pointer   // AMSI_RESULT* out
): Integer; stdcall;
  external 'Amsi.dll' name 'AmsiScanString';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "AmsiScanString"
  c_AmsiScanString :: Ptr () -> CWString -> CWString -> Ptr () -> Ptr Int32 -> IO Int32
-- amsiContext : HAMSICONTEXT -> Ptr ()
-- string : LPCWSTR -> CWString
-- contentName : LPCWSTR optional -> CWString
-- amsiSession : HAMSISESSION optional -> Ptr ()
-- result : AMSI_RESULT* out -> Ptr Int32
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let amsiscanstring =
  foreign "AmsiScanString"
    ((ptr void) @-> (ptr uint16_t) @-> (ptr uint16_t) @-> (ptr void) @-> (ptr int32_t) @-> returning int32_t)
(* amsiContext : HAMSICONTEXT -> (ptr void) *)
(* string : LPCWSTR -> (ptr uint16_t) *)
(* contentName : LPCWSTR optional -> (ptr uint16_t) *)
(* amsiSession : HAMSISESSION optional -> (ptr void) *)
(* result : AMSI_RESULT* out -> (ptr int32_t) *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)
(cffi:define-foreign-library amsi (t "Amsi.dll"))
(cffi:use-foreign-library amsi)

(cffi:defcfun ("AmsiScanString" amsi-scan-string :convention :stdcall) :int32
  (amsi-context :pointer)   ; HAMSICONTEXT
  (string (:string :encoding :utf-16le))   ; LPCWSTR
  (content-name (:string :encoding :utf-16le))   ; LPCWSTR optional
  (amsi-session :pointer)   ; HAMSISESSION optional
  (result :pointer))   ; AMSI_RESULT* out
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $AmsiScanString = Win32::API::More->new('Amsi',
    'int AmsiScanString(HANDLE amsiContext, LPCWSTR string, LPCWSTR contentName, HANDLE amsiSession, LPVOID result)');
# my $ret = $AmsiScanString->Call($amsiContext, $string, $contentName, $amsiSession, $result);
# amsiContext : HAMSICONTEXT -> HANDLE
# string : LPCWSTR -> LPCWSTR
# contentName : LPCWSTR optional -> LPCWSTR
# amsiSession : HAMSISESSION optional -> HANDLE
# result : AMSI_RESULT* out -> LPVOID
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。

関連項目

使用する型