Win32 API 日本語リファレンス
ホームDevices.Tapi › lineGetIconA

lineGetIconA

関数
回線デバイスに関連付けられたアイコンを取得する(ANSI版)。
DLLTAPI32.dll文字セットANSI (-A)呼出規約winapi

シグネチャ

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

INT lineGetIconA(
    DWORD dwDeviceID,
    LPCSTR lpszDeviceClass,
    HICON* lphIcon
);

パラメーター

名前方向説明
dwDeviceIDDWORDinアイコンを取得する回線デバイスのID。
lpszDeviceClassLPCSTRinアイコンを取得するデバイスクラスを示すANSI文字列。NULL可で既定アイコンを返す。
lphIconHICON*inout取得したアイコンのハンドルを受け取るHICONへのポインタ。

戻り値の型: INT

各言語での呼び出し定義

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

INT lineGetIconA(
    DWORD dwDeviceID,
    LPCSTR lpszDeviceClass,
    HICON* lphIcon
);
[DllImport("TAPI32.dll", CharSet = CharSet.Ansi, ExactSpelling = true)]
static extern int lineGetIconA(
    uint dwDeviceID,   // DWORD
    [MarshalAs(UnmanagedType.LPStr)] string lpszDeviceClass,   // LPCSTR
    IntPtr lphIcon   // HICON* in/out
);
<DllImport("TAPI32.dll", CharSet:=CharSet.Ansi, ExactSpelling:=True)>
Public Shared Function lineGetIconA(
    dwDeviceID As UInteger,   ' DWORD
    <MarshalAs(UnmanagedType.LPStr)> lpszDeviceClass As String,   ' LPCSTR
    lphIcon As IntPtr   ' HICON* in/out
) As Integer
End Function
' dwDeviceID : DWORD
' lpszDeviceClass : LPCSTR
' lphIcon : HICON* in/out
Declare PtrSafe Function lineGetIconA Lib "tapi32" ( _
    ByVal dwDeviceID As Long, _
    ByVal lpszDeviceClass As String, _
    ByVal lphIcon As LongPtr) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。
import ctypes
from ctypes import wintypes

lineGetIconA = ctypes.windll.tapi32.lineGetIconA
lineGetIconA.restype = ctypes.c_int
lineGetIconA.argtypes = [
    wintypes.DWORD,  # dwDeviceID : DWORD
    wintypes.LPCSTR,  # lpszDeviceClass : LPCSTR
    ctypes.c_void_p,  # lphIcon : HICON* in/out
]
require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('TAPI32.dll')
lineGetIconA = Fiddle::Function.new(
  lib['lineGetIconA'],
  [
    -Fiddle::TYPE_INT,  # dwDeviceID : DWORD
    Fiddle::TYPE_VOIDP,  # lpszDeviceClass : LPCSTR
    Fiddle::TYPE_VOIDP,  # lphIcon : HICON* in/out
  ],
  Fiddle::TYPE_INT)
#[link(name = "tapi32")]
extern "system" {
    fn lineGetIconA(
        dwDeviceID: u32,  // DWORD
        lpszDeviceClass: *const u8,  // LPCSTR
        lphIcon: *mut *mut core::ffi::c_void  // HICON* in/out
    ) -> i32;
}
// crates: windows-sys provides ready-made bindings for this API.
$sig = @"
[DllImport("TAPI32.dll", CharSet = CharSet.Ansi)]
public static extern int lineGetIconA(uint dwDeviceID, [MarshalAs(UnmanagedType.LPStr)] string lpszDeviceClass, IntPtr lphIcon);
"@
$api = Add-Type -MemberDefinition $sig -Name 'TAPI32_lineGetIconA' -Namespace Win32 -PassThru
# $api::lineGetIconA(dwDeviceID, lpszDeviceClass, lphIcon)
#uselib "TAPI32.dll"
#func global lineGetIconA "lineGetIconA" sptr, sptr, sptr
; lineGetIconA dwDeviceID, lpszDeviceClass, lphIcon   ; 戻り値は stat
; dwDeviceID : DWORD -> "sptr"
; lpszDeviceClass : LPCSTR -> "sptr"
; lphIcon : HICON* in/out -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
#uselib "TAPI32.dll"
#cfunc global lineGetIconA "lineGetIconA" int, str, sptr
; res = lineGetIconA(dwDeviceID, lpszDeviceClass, lphIcon)
; dwDeviceID : DWORD -> "int"
; lpszDeviceClass : LPCSTR -> "str"
; lphIcon : HICON* in/out -> "sptr"
; INT lineGetIconA(DWORD dwDeviceID, LPCSTR lpszDeviceClass, HICON* lphIcon)
#uselib "TAPI32.dll"
#cfunc global lineGetIconA "lineGetIconA" int, str, intptr
; res = lineGetIconA(dwDeviceID, lpszDeviceClass, lphIcon)
; dwDeviceID : DWORD -> "int"
; lpszDeviceClass : LPCSTR -> "str"
; lphIcon : HICON* in/out -> "intptr"
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	tapi32 = windows.NewLazySystemDLL("TAPI32.dll")
	proclineGetIconA = tapi32.NewProc("lineGetIconA")
)

// dwDeviceID (DWORD), lpszDeviceClass (LPCSTR), lphIcon (HICON* in/out)
r1, _, err := proclineGetIconA.Call(
	uintptr(dwDeviceID),
	uintptr(unsafe.Pointer(windows.BytePtrFromString(lpszDeviceClass))),
	uintptr(lphIcon),
)
_ = err  // syscall.Errno (valid when the call sets last-error)
_ = r1   // INT
function lineGetIconA(
  dwDeviceID: DWORD;   // DWORD
  lpszDeviceClass: PAnsiChar;   // LPCSTR
  lphIcon: Pointer   // HICON* in/out
): Integer; stdcall;
  external 'TAPI32.dll' name 'lineGetIconA';
result := DllCall("TAPI32\lineGetIconA"
    , "UInt", dwDeviceID   ; DWORD
    , "AStr", lpszDeviceClass   ; LPCSTR
    , "Ptr", lphIcon   ; HICON* in/out
    , "Int")   ; return: INT
●lineGetIconA(dwDeviceID, lpszDeviceClass, lphIcon) = DLL("TAPI32.dll", "int lineGetIconA(dword, char*, void*)")
# 呼び出し: lineGetIconA(dwDeviceID, lpszDeviceClass, lphIcon)
# dwDeviceID : DWORD -> "dword"
# lpszDeviceClass : LPCSTR -> "char*"
# lphIcon : HICON* in/out -> "void*"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。
const std = @import("std");

extern "tapi32" fn lineGetIconA(
    dwDeviceID: u32, // DWORD
    lpszDeviceClass: [*c]const u8, // LPCSTR
    lphIcon: ?*anyopaque // HICON* in/out
) callconv(std.os.windows.WINAPI) i32;
proc lineGetIconA(
    dwDeviceID: uint32,  # DWORD
    lpszDeviceClass: cstring,  # LPCSTR
    lphIcon: pointer  # HICON* in/out
): int32 {.importc: "lineGetIconA", stdcall, dynlib: "TAPI32.dll".}
pragma(lib, "tapi32");
extern(Windows)
int lineGetIconA(
    uint dwDeviceID,   // DWORD
    const(char)* lpszDeviceClass,   // LPCSTR
    void* lphIcon   // HICON* in/out
);
ccall((:lineGetIconA, "TAPI32.dll"), stdcall, Int32,
      (UInt32, Cstring, Ptr{Cvoid}),
      dwDeviceID, lpszDeviceClass, lphIcon)
# dwDeviceID : DWORD -> UInt32
# lpszDeviceClass : LPCSTR -> Cstring
# lphIcon : HICON* in/out -> Ptr{Cvoid}
# stdcall は 32bit のみ意味を持つ(x64 では無視)。
local ffi = require("ffi")
ffi.cdef[[
int32_t lineGetIconA(
    uint32_t dwDeviceID,
    const char* lpszDeviceClass,
    void* lphIcon);
]]
local tapi32 = ffi.load("tapi32")
-- tapi32.lineGetIconA(dwDeviceID, lpszDeviceClass, lphIcon)
-- dwDeviceID : DWORD
-- lpszDeviceClass : LPCSTR
-- lphIcon : HICON* in/out
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
const koffi = require('koffi');
const lib = koffi.load('TAPI32.dll');
const lineGetIconA = lib.func('__stdcall', 'lineGetIconA', 'int32_t', ['uint32_t', 'str', 'void *']);
// lineGetIconA(dwDeviceID, lpszDeviceClass, lphIcon)
// dwDeviceID : DWORD -> 'uint32_t'
// lpszDeviceClass : LPCSTR -> 'str'
// lphIcon : HICON* in/out -> 'void *'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。
const lib = Deno.dlopen("TAPI32.dll", {
  lineGetIconA: { parameters: ["u32", "buffer", "pointer"], result: "i32" },
});
// lib.symbols.lineGetIconA(dwDeviceID, lpszDeviceClass, lphIcon)
// dwDeviceID : DWORD -> "u32"
// lpszDeviceClass : LPCSTR -> "buffer"
// lphIcon : HICON* in/out -> "pointer"
// 文字列は "buffer"。ANSI(-A) は new TextEncoder() で UTF-8/ANSI バイト列(末尾に \x00)を渡す。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。
<?php
$ffi = FFI::cdef(<<<C
int32_t lineGetIconA(
    uint32_t dwDeviceID,
    const char* lpszDeviceClass,
    void* lphIcon);
C, "TAPI32.dll");
// $ffi->lineGetIconA(dwDeviceID, lpszDeviceClass, lphIcon);
// dwDeviceID : DWORD
// lpszDeviceClass : LPCSTR
// lphIcon : HICON* in/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 Tapi32 extends StdCallLibrary {
    Tapi32 INSTANCE = Native.load("tapi32", Tapi32.class, W32APIOptions.ASCII_OPTIONS);
    int lineGetIconA(
        int dwDeviceID,   // DWORD
        String lpszDeviceClass,   // LPCSTR
        Pointer lphIcon   // HICON* in/out
    );
}
@[Link("tapi32")]
lib LibTAPI32
  fun lineGetIconA = lineGetIconA(
    dwDeviceID : UInt32,   # DWORD
    lpszDeviceClass : UInt8*,   # LPCSTR
    lphIcon : Void*   # HICON* in/out
  ) : Int32
end
# 構造体/GUID/enum は lib 内に対応する型定義が必要。
# 呼出規約: x64 は規約統一のため OK。x86(32bit)は WINAPI=stdcall だが Crystal の fun に stdcall 付与構文がなく非対応。
import 'dart:ffi';
import 'package:ffi/ffi.dart';

typedef lineGetIconANative = Int32 Function(Uint32, Pointer<Utf8>, Pointer<Void>);
typedef lineGetIconADart = int Function(int, Pointer<Utf8>, Pointer<Void>);
final lineGetIconA = DynamicLibrary.open('TAPI32.dll')
    .lookupFunction<lineGetIconANative, lineGetIconADart>('lineGetIconA');
// dwDeviceID : DWORD -> Uint32
// lpszDeviceClass : LPCSTR -> Pointer<Utf8>
// lphIcon : HICON* in/out -> Pointer<Void>
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function lineGetIconA(
  dwDeviceID: DWORD;   // DWORD
  lpszDeviceClass: PAnsiChar;   // LPCSTR
  lphIcon: Pointer   // HICON* in/out
): Integer; stdcall;
  external 'TAPI32.dll' name 'lineGetIconA';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "lineGetIconA"
  c_lineGetIconA :: Word32 -> CString -> Ptr () -> IO Int32
-- dwDeviceID : DWORD -> Word32
-- lpszDeviceClass : LPCSTR -> CString
-- lphIcon : HICON* in/out -> Ptr ()
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let linegeticona =
  foreign "lineGetIconA"
    (uint32_t @-> string @-> (ptr void) @-> returning int32_t)
(* dwDeviceID : DWORD -> uint32_t *)
(* lpszDeviceClass : LPCSTR -> string *)
(* lphIcon : HICON* in/out -> (ptr void) *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)
(cffi:define-foreign-library tapi32 (t "TAPI32.dll"))
(cffi:use-foreign-library tapi32)

(cffi:defcfun ("lineGetIconA" line-get-icon-a :convention :stdcall) :int32
  (dw-device-id :uint32)   ; DWORD
  (lpsz-device-class :string)   ; LPCSTR
  (lph-icon :pointer))   ; HICON* in/out
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $lineGetIconA = Win32::API::More->new('TAPI32',
    'int lineGetIconA(DWORD dwDeviceID, LPCSTR lpszDeviceClass, HANDLE lphIcon)');
# my $ret = $lineGetIconA->Call($dwDeviceID, $lpszDeviceClass, $lphIcon);
# dwDeviceID : DWORD -> DWORD
# lpszDeviceClass : LPCSTR -> LPCSTR
# lphIcon : HICON* in/out -> HANDLE
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。

関連項目

文字セット違い