lineClose
関数シグネチャ
// TAPI32.dll
#include <windows.h>
INT lineClose(
DWORD hLine
);パラメーター
| 名前 | 型 | 方向 | 説明 |
|---|---|---|---|
| hLine | DWORD | in | 閉じる対象の、オープン済み回線デバイスへのハンドル。回線が正常に閉じられた後は、このハンドルは無効になります。 |
戻り値の型: INT
公式ドキュメント
lineClose 関数は、指定されたオープン済みの回線デバイスを閉じます。
戻り値
要求が成功した場合は 0 を、エラーが発生した場合は負のエラー番号を返します。返される可能性のある値は次のとおりです。
LINEERR_INVALLINEHANDLE、LINEERR_RESOURCEUNAVAIL、LINEERR_NOMEM、LINEERR_UNINITIALIZED、LINEERR_OPERATIONFAILED、LINEERR_OPERATIONUNAVAIL。
解説(Remarks)
アプリケーションが、オープンした回線上にアクティブな呼び出しを残したまま lineClose を呼び出した場合、それらの呼び出しに対するアプリケーションの所有権は取り消されます。アプリケーションがそれらの呼び出しの唯一の所有者であった場合は、呼び出しも切断されます。オープンした回線上で所有している呼び出しについては、回線を閉じる前に、明示的に所有権を放棄するか、または呼び出しを切断して処理しておくことが、良いプログラミングの態度です。
回線が正常に閉じられた場合、オープン・クローズの変化について回線の状態を監視しているすべてのアプリケーションに LINE_LINEDEVSTATE メッセージが送信されます。未完了の非同期応答は抑制されます。
サービス プロバイダーにとっては、回線をオープンしているアプリケーションから回線デバイスを強制的に回収することが有用であったり、必要であったりする場合があります。これは、アプリケーションが回線デバイスを長時間独占するのを防ぐのに役立ちます。このような場合、閉じられた回線デバイスの回線ハンドルを指定した LINE_CLOSE メッセージが、そのアプリケーションに送信されます。
lineOpen 関数は、呼び出し元のアプリケーションにリソースを割り当てます。そのため、リソースが不足している場合には、アプリケーションは回線をオープンできないことがあります。したがって、(発信のためなど) 回線デバイスを時々しか使用しないアプリケーションは、回線を閉じてリソースを解放し、他のアプリケーションが回線をオープンできるようにすべきです。
Microsoft 公式リファレンス: 英語 (en-us) · 日本語 (ja-jp) · 原文ソース (GitHub)
各言語での呼び出し定義
// TAPI32.dll
#include <windows.h>
INT lineClose(
DWORD hLine
);[DllImport("TAPI32.dll", ExactSpelling = true)]
static extern int lineClose(
uint hLine // DWORD
);<DllImport("TAPI32.dll", ExactSpelling:=True)>
Public Shared Function lineClose(
hLine As UInteger ' DWORD
) As Integer
End Function' hLine : DWORD
Declare PtrSafe Function lineClose Lib "tapi32" ( _
ByVal hLine As Long) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。import ctypes
from ctypes import wintypes
lineClose = ctypes.windll.tapi32.lineClose
lineClose.restype = ctypes.c_int
lineClose.argtypes = [
wintypes.DWORD, # hLine : DWORD
]require 'fiddle'
require 'fiddle/import'
lib = Fiddle.dlopen('TAPI32.dll')
lineClose = Fiddle::Function.new(
lib['lineClose'],
[
-Fiddle::TYPE_INT, # hLine : DWORD
],
Fiddle::TYPE_INT)#[link(name = "tapi32")]
extern "system" {
fn lineClose(
hLine: u32 // DWORD
) -> i32;
}
// crates: windows-sys provides ready-made bindings for this API.$sig = @"
[DllImport("TAPI32.dll")]
public static extern int lineClose(uint hLine);
"@
$api = Add-Type -MemberDefinition $sig -Name 'TAPI32_lineClose' -Namespace Win32 -PassThru
# $api::lineClose(hLine)#uselib "TAPI32.dll"
#func global lineClose "lineClose" sptr
; lineClose hLine ; 戻り値は stat
; hLine : DWORD -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。#uselib "TAPI32.dll"
#cfunc global lineClose "lineClose" int
; res = lineClose(hLine)
; hLine : DWORD -> "int"; INT lineClose(DWORD hLine)
#uselib "TAPI32.dll"
#cfunc global lineClose "lineClose" int
; res = lineClose(hLine)
; hLine : DWORD -> "int"import (
"golang.org/x/sys/windows"
"unsafe"
)
var (
tapi32 = windows.NewLazySystemDLL("TAPI32.dll")
proclineClose = tapi32.NewProc("lineClose")
)
// hLine (DWORD)
r1, _, err := proclineClose.Call(
uintptr(hLine),
)
_ = err // syscall.Errno (valid when the call sets last-error)
_ = r1 // INTfunction lineClose(
hLine: DWORD // DWORD
): Integer; stdcall;
external 'TAPI32.dll' name 'lineClose';result := DllCall("TAPI32\lineClose"
, "UInt", hLine ; DWORD
, "Int") ; return: INT●lineClose(hLine) = DLL("TAPI32.dll", "int lineClose(dword)")
# 呼び出し: lineClose(hLine)
# hLine : DWORD -> "dword"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。const std = @import("std");
extern "tapi32" fn lineClose(
hLine: u32 // DWORD
) callconv(std.os.windows.WINAPI) i32;proc lineClose(
hLine: uint32 # DWORD
): int32 {.importc: "lineClose", stdcall, dynlib: "TAPI32.dll".}pragma(lib, "tapi32");
extern(Windows)
int lineClose(
uint hLine // DWORD
);ccall((:lineClose, "TAPI32.dll"), stdcall, Int32,
(UInt32,),
hLine)
# hLine : DWORD -> UInt32
# stdcall は 32bit のみ意味を持つ(x64 では無視)。local ffi = require("ffi")
ffi.cdef[[
int32_t lineClose(
uint32_t hLine);
]]
local tapi32 = ffi.load("tapi32")
-- tapi32.lineClose(hLine)
-- hLine : DWORD
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。const koffi = require('koffi');
const lib = koffi.load('TAPI32.dll');
const lineClose = lib.func('__stdcall', 'lineClose', 'int32_t', ['uint32_t']);
// lineClose(hLine)
// hLine : DWORD -> 'uint32_t'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。const lib = Deno.dlopen("TAPI32.dll", {
lineClose: { parameters: ["u32"], result: "i32" },
});
// lib.symbols.lineClose(hLine)
// hLine : DWORD -> "u32"
// 文字列引数は "buffer"(NUL 終端のバイト列を Uint8Array で渡す)。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。<?php
$ffi = FFI::cdef(<<<C
int32_t lineClose(
uint32_t hLine);
C, "TAPI32.dll");
// $ffi->lineClose(hLine);
// hLine : DWORD
// 構造体/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);
int lineClose(
int hLine // DWORD
);
}@[Link("tapi32")]
lib LibTAPI32
fun lineClose = lineClose(
hLine : UInt32 # DWORD
) : Int32
end
# 構造体/GUID/enum は lib 内に対応する型定義が必要。
# 呼出規約: x64 は規約統一のため OK。x86(32bit)は WINAPI=stdcall だが Crystal の fun に stdcall 付与構文がなく非対応。import 'dart:ffi';
import 'package:ffi/ffi.dart';
typedef lineCloseNative = Int32 Function(Uint32);
typedef lineCloseDart = int Function(int);
final lineClose = DynamicLibrary.open('TAPI32.dll')
.lookupFunction<lineCloseNative, lineCloseDart>('lineClose');
// hLine : DWORD -> Uint32
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。{$mode objfpc}{$H+}
function lineClose(
hLine: DWORD // DWORD
): Integer; stdcall;
external 'TAPI32.dll' name 'lineClose';import Foreign
import Foreign.C.Types
import Foreign.C.String
foreign import stdcall safe "lineClose"
c_lineClose :: Word32 -> IO Int32
-- hLine : DWORD -> Word32
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。open Ctypes
open Foreign
let lineclose =
foreign "lineClose"
(uint32_t @-> returning int32_t)
(* hLine : DWORD -> uint32_t *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)(cffi:define-foreign-library tapi32 (t "TAPI32.dll"))
(cffi:use-foreign-library tapi32)
(cffi:defcfun ("lineClose" line-close :convention :stdcall) :int32
(h-line :uint32)) ; DWORD
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。use Win32::API;
my $lineClose = Win32::API::More->new('TAPI32',
'int lineClose(DWORD hLine)');
# my $ret = $lineClose->Call($hLine);
# hLine : DWORD -> DWORD
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。関連項目
- f lineOpenW — 回線デバイスを開いてハンドルを取得する(Unicode版)。