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

lineSetDevConfigA

関数
回線デバイスの構成情報をANSI文字列で設定する。
DLLTAPI32.dll文字セットANSI (-A)呼出規約winapi
📘 Microsoft Learn (日本語) · English

シグネチャ

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

INT lineSetDevConfigA(
    DWORD dwDeviceID,
    const void* lpDeviceConfig,
    DWORD dwSize,
    LPCSTR lpszDeviceClass
);

パラメーター

名前型方向説明
dwDeviceIDDWORDin構成する回線デバイスの識別子。
lpDeviceConfigvoid*in内容が不透明な構成データ構造体へのポインター。この構造体は lineGetDevConfig によって VARSTRING 構造体の可変部分で返されたものです。
dwSizeDWORDinlpDeviceConfig が指す構造体のバイト数。この値は、 lineGetDevConfig が返す VARSTRING 構造体の dwStringSize メンバーで返されます。
lpszDeviceClassLPCSTRin構成を設定する対象デバイスのデバイスクラスを指定する、null で終わる文字列へのポインター。有効なデバイスクラス文字列は、 lineGetID 関数に指定するものと同じです。

戻り値の型: INT

公式ドキュメント

lineSetDevConfig 関数を使用すると、アプリケーションは、以前に lineGetDevConfig で取得した設定内容に、回線デバイス上のメディアストリームデバイスの構成を復元できます。(lineSetDevConfigA)

戻り値

関数が成功した場合は 0 を、エラーが発生した場合は負のエラー番号を返します。返される可能性のある値は次のとおりです。

LINEERR_BADDEVICEID, LINEERR_NODRIVER, LINEERR_INVALDEVICECLASS, LINEERR_OPERATIONUNAVAIL, LINEERR_INVALPOINTER, LINEERR_OPERATIONFAILED, LINEERR_INVALPARAM, LINEERR_RESOURCEUNAVAIL, LINEERR_INVALLINESTATE, LINEERR_UNINITIALIZED, LINEERR_NOMEM, LINEERR_NODEVICE.

解説(Remarks)

コール状態はデバイス固有です。

通常、アプリケーションは lineGetID を呼び出して回線に関連付けられたメディアストリームデバイスを特定し、続いて lineConfigDialog を呼び出して、ユーザーにデバイスの構成を設定させます。その後、 lineGetDevConfig を呼び出して、特定の通話先に関連付けられた電話帳やその他のデータベースに構成情報を保存できます。ユーザーが同じ通話先に再び発信するときは、この lineSetDevConfig 関数を使用して、ユーザーが選択した構成設定を復元できます。 lineSetDevConfig、 lineConfigDialog、 lineGetDevConfig の各関数をこの順序で使用すると、ユーザーが設定を表示して更新できるようになります。

構造体に含まれるデータの正確な形式は、回線およびメディアストリーム API (デバイスクラス) に固有であり、文書化されておらず、未定義です。アプリケーションはこれを「不透明 (opaque)」なものとして扱い、その内容を直接操作してはなりません。一般に、この構造体は、この関数を使用して、取得元と同じデバイスに対してのみ送信できます。ただし、テレフォニーサービスプロバイダーによっては、同一のデバイス間 (つまり、同じマルチポートモデムカード上の複数のポート) で構造体を交換できる場合があります。そのような交換可能性は、同じデバイスクラスのデバイスであっても、いかなる形でも保証されません。

サービスプロバイダーによっては、通話がアクティブな間に構成を設定できる場合もあれば、できない場合もあります。

メモ

tapi.h ヘッダーは、UNICODE プリプロセッサ定数の定義に基づいて、この関数の ANSI 版または Unicode 版を自動的に選択するエイリアスとして lineSetDevConfig を定義します。エンコードに依存しないエイリアスの使用と、エンコードに依存しないコードではないコードとを混在させると、不一致が生じ、コンパイルエラーや実行時エラーの原因となる可能性があります。詳細については、「Conventions for Function Prototypes」を参照してください。

出典・ライセンス: 上記「公式ドキュメント」の内容は Microsoft の Win32 API ドキュメント(MicrosoftDocs/sdk-api)を日本語に翻訳・改変したものです。© Microsoft Corporation. CC BY 4.0 で提供。
Microsoft 公式リファレンス: 英語 (en-us) · 日本語 (ja-jp) · 原文ソース (GitHub)

各言語での呼び出し定義

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

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

lineSetDevConfigA = ctypes.windll.tapi32.lineSetDevConfigA
lineSetDevConfigA.restype = ctypes.c_int
lineSetDevConfigA.argtypes = [
    wintypes.DWORD,  # dwDeviceID : DWORD
    ctypes.POINTER(None),  # lpDeviceConfig : void*
    wintypes.DWORD,  # dwSize : DWORD
    wintypes.LPCSTR,  # lpszDeviceClass : LPCSTR
]
require 'fiddle'
require 'fiddle/import'

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

var (
	tapi32 = windows.NewLazySystemDLL("TAPI32.dll")
	proclineSetDevConfigA = tapi32.NewProc("lineSetDevConfigA")
)

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

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

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

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

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

(cffi:defcfun ("lineSetDevConfigA" line-set-dev-config-a :convention :stdcall) :int32
  (dw-device-id :uint32)   ; DWORD
  (lp-device-config :pointer)   ; void*
  (dw-size :uint32)   ; DWORD
  (lpsz-device-class :string))   ; LPCSTR
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $lineSetDevConfigA = Win32::API::More->new('TAPI32',
    'int lineSetDevConfigA(DWORD dwDeviceID, LPVOID lpDeviceConfig, DWORD dwSize, LPCSTR lpszDeviceClass)');
# my $ret = $lineSetDevConfigA->Call($dwDeviceID, $lpDeviceConfig, $dwSize, $lpszDeviceClass);
# dwDeviceID : DWORD -> DWORD
# lpDeviceConfig : void* -> LPVOID
# dwSize : DWORD -> DWORD
# lpszDeviceClass : LPCSTR -> LPCSTR
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。

関連項目

文字セット違い
公式の関連項目