lineGetRequest
関数シグネチャ
// TAPI32.dll (ANSI / -A)
#include <windows.h>
INT lineGetRequest(
DWORD hLineApp,
DWORD dwRequestMode,
void* lpRequestBuffer
);パラメーター
| 名前 | 型 | 方向 | 説明 |
|---|---|---|---|
| hLineApp | DWORD | in | TAPI の回線部分に対するアプリケーション使用ハンドルです。 |
| dwRequestMode | DWORD | in | 取得する要求の種類です。dwRequestMode には 1 つのビットしか設定できない点に注意してください。このパラメーターには、 LINEREQUESTMODE_ 定数のうち 1 つだけを使用します。 |
| lpRequestBuffer | void* | inout | 要求のパラメーターが格納されるメモリバッファーへのポインターです。バッファーのサイズと、バッファーに格納されるデータの解釈方法は、要求モードによって異なります。アプリケーションが割り当てるバッファーは、要求を保持するのに十分なサイズであることが前提となります。 dwRequestMode が LINEREQUESTMODE_MAKECALL の場合は、要求バッファーの内容を LINEREQMAKECALL 構造体として解釈します。 LINEREQUESTMODE_MEDIACALL は廃止されています。詳細については、tapiRequestMediaCall を参照してください。 |
戻り値の型: INT
公式ドキュメント
lineGetRequest 関数 (tapi.h) は、指定された要求モードに対する次の代理 (by-proxy) 要求を取得します。
戻り値
要求が成功した場合は 0 を返し、エラーが発生した場合は負のエラー番号を返します。返される可能性のある値は次のとおりです。
LINEERR_INVALAPPHANDLE、LINEERR_NOTREGISTERED、LINEERR_INVALPOINTER、LINEERR_OPERATIONFAILED、LINEERR_INVALREQUESTMODE、LINEERR_RESOURCEUNAVAIL、LINEERR_NOMEM、LINEERR_UNINITIALIZED、LINEERR_NOREQUEST。
解説(Remarks)
テレフォニー対応アプリケーションは、 tapiRequestMakeCall を呼び出すことで、自身に代わって通話を発信するよう要求できます。これらの要求は TAPI によってキューに入れられ、その要求を処理するために登録されている最も優先度の高いアプリケーションに対して、保留中の要求のモードを示す LINE_REQUEST メッセージが送信されます。通常、このアプリケーションはユーザーの通話制御アプリケーションです。LINE_REQUEST メッセージは、登録済みアプリケーションが処理すべき要求が 0 個以上保留中である可能性を示します。LINE_REQUEST を受信した後、受信側アプリケーションは、保留中の要求がこれ以上ないことを示す LINEERR_NOREQUEST が返されるまで lineGetRequest を呼び出す責任があります。
次に、このメッセージを受け取った通話制御アプリケーションは、要求モードと、要求を保持するのに十分な大きさのバッファーを指定して lineGetRequest を呼び出します。その後、通話制御アプリケーションは要求を解釈して実行します。
lineGetRequest の実行後、TAPI は内部キューからその要求を削除し、後続の要求のための領域を確保します。そのため、同じアプリケーションまたは別のアプリケーションが新たな要求を発行した場合、 lineGetRequest の実行直後に新しい LINE_REQUEST メッセージを受信する可能性があります。この状況に何らかの仕組みで対処するのは、要求を受信するアプリケーションの責任です。たとえば、追加の LINE_REQUEST を記録しておき、先行する要求の処理が完了するまで後続の lineGetRequest を延期する、必要に応じて後続の要求とバッファーを取得する、またはその他の適切な方法で対処します。
後続の LINE_REQUEST は TAPI によって再送されないため、無視しないでください。
Microsoft 公式リファレンス: 英語 (en-us) · 日本語 (ja-jp) · 原文ソース (GitHub)
各言語での呼び出し定義
// TAPI32.dll (ANSI / -A)
#include <windows.h>
INT lineGetRequest(
DWORD hLineApp,
DWORD dwRequestMode,
void* lpRequestBuffer
);[DllImport("TAPI32.dll", CharSet = CharSet.Ansi, ExactSpelling = true)]
static extern int lineGetRequest(
uint hLineApp, // DWORD
uint dwRequestMode, // DWORD
IntPtr lpRequestBuffer // void* in/out
);<DllImport("TAPI32.dll", CharSet:=CharSet.Ansi, ExactSpelling:=True)>
Public Shared Function lineGetRequest(
hLineApp As UInteger, ' DWORD
dwRequestMode As UInteger, ' DWORD
lpRequestBuffer As IntPtr ' void* in/out
) As Integer
End Function' hLineApp : DWORD
' dwRequestMode : DWORD
' lpRequestBuffer : void* in/out
Declare PtrSafe Function lineGetRequest Lib "tapi32" ( _
ByVal hLineApp As Long, _
ByVal dwRequestMode As Long, _
ByVal lpRequestBuffer As LongPtr) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。import ctypes
from ctypes import wintypes
lineGetRequest = ctypes.windll.tapi32.lineGetRequest
lineGetRequest.restype = ctypes.c_int
lineGetRequest.argtypes = [
wintypes.DWORD, # hLineApp : DWORD
wintypes.DWORD, # dwRequestMode : DWORD
ctypes.POINTER(None), # lpRequestBuffer : void* in/out
]require 'fiddle'
require 'fiddle/import'
lib = Fiddle.dlopen('TAPI32.dll')
lineGetRequest = Fiddle::Function.new(
lib['lineGetRequest'],
[
-Fiddle::TYPE_INT, # hLineApp : DWORD
-Fiddle::TYPE_INT, # dwRequestMode : DWORD
Fiddle::TYPE_VOIDP, # lpRequestBuffer : void* in/out
],
Fiddle::TYPE_INT)#[link(name = "tapi32")]
extern "system" {
fn lineGetRequest(
hLineApp: u32, // DWORD
dwRequestMode: u32, // DWORD
lpRequestBuffer: *mut () // void* in/out
) -> i32;
}
// crates: windows-sys provides ready-made bindings for this API.$sig = @"
[DllImport("TAPI32.dll", CharSet = CharSet.Ansi)]
public static extern int lineGetRequest(uint hLineApp, uint dwRequestMode, IntPtr lpRequestBuffer);
"@
$api = Add-Type -MemberDefinition $sig -Name 'TAPI32_lineGetRequest' -Namespace Win32 -PassThru
# $api::lineGetRequest(hLineApp, dwRequestMode, lpRequestBuffer)#uselib "TAPI32.dll"
#func global lineGetRequest "lineGetRequest" sptr, sptr, sptr
; lineGetRequest hLineApp, dwRequestMode, lpRequestBuffer ; 戻り値は stat
; hLineApp : DWORD -> "sptr"
; dwRequestMode : DWORD -> "sptr"
; lpRequestBuffer : void* in/out -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。#uselib "TAPI32.dll"
#cfunc global lineGetRequest "lineGetRequest" int, int, sptr
; res = lineGetRequest(hLineApp, dwRequestMode, lpRequestBuffer)
; hLineApp : DWORD -> "int"
; dwRequestMode : DWORD -> "int"
; lpRequestBuffer : void* in/out -> "sptr"; INT lineGetRequest(DWORD hLineApp, DWORD dwRequestMode, void* lpRequestBuffer)
#uselib "TAPI32.dll"
#cfunc global lineGetRequest "lineGetRequest" int, int, intptr
; res = lineGetRequest(hLineApp, dwRequestMode, lpRequestBuffer)
; hLineApp : DWORD -> "int"
; dwRequestMode : DWORD -> "int"
; lpRequestBuffer : void* in/out -> "intptr"import (
"golang.org/x/sys/windows"
"unsafe"
)
var (
tapi32 = windows.NewLazySystemDLL("TAPI32.dll")
proclineGetRequest = tapi32.NewProc("lineGetRequest")
)
// hLineApp (DWORD), dwRequestMode (DWORD), lpRequestBuffer (void* in/out)
r1, _, err := proclineGetRequest.Call(
uintptr(hLineApp),
uintptr(dwRequestMode),
uintptr(lpRequestBuffer),
)
_ = err // syscall.Errno (valid when the call sets last-error)
_ = r1 // INTfunction lineGetRequest(
hLineApp: DWORD; // DWORD
dwRequestMode: DWORD; // DWORD
lpRequestBuffer: Pointer // void* in/out
): Integer; stdcall;
external 'TAPI32.dll' name 'lineGetRequest';result := DllCall("TAPI32\lineGetRequest"
, "UInt", hLineApp ; DWORD
, "UInt", dwRequestMode ; DWORD
, "Ptr", lpRequestBuffer ; void* in/out
, "Int") ; return: INT●lineGetRequest(hLineApp, dwRequestMode, lpRequestBuffer) = DLL("TAPI32.dll", "int lineGetRequest(dword, dword, void*)")
# 呼び出し: lineGetRequest(hLineApp, dwRequestMode, lpRequestBuffer)
# hLineApp : DWORD -> "dword"
# dwRequestMode : DWORD -> "dword"
# lpRequestBuffer : void* in/out -> "void*"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。const std = @import("std");
extern "tapi32" fn lineGetRequest(
hLineApp: u32, // DWORD
dwRequestMode: u32, // DWORD
lpRequestBuffer: ?*anyopaque // void* in/out
) callconv(std.os.windows.WINAPI) i32;proc lineGetRequest(
hLineApp: uint32, # DWORD
dwRequestMode: uint32, # DWORD
lpRequestBuffer: pointer # void* in/out
): int32 {.importc: "lineGetRequest", stdcall, dynlib: "TAPI32.dll".}pragma(lib, "tapi32");
extern(Windows)
int lineGetRequest(
uint hLineApp, // DWORD
uint dwRequestMode, // DWORD
void* lpRequestBuffer // void* in/out
);ccall((:lineGetRequest, "TAPI32.dll"), stdcall, Int32,
(UInt32, UInt32, Ptr{Cvoid}),
hLineApp, dwRequestMode, lpRequestBuffer)
# hLineApp : DWORD -> UInt32
# dwRequestMode : DWORD -> UInt32
# lpRequestBuffer : void* in/out -> Ptr{Cvoid}
# stdcall は 32bit のみ意味を持つ(x64 では無視)。local ffi = require("ffi")
ffi.cdef[[
int32_t lineGetRequest(
uint32_t hLineApp,
uint32_t dwRequestMode,
void* lpRequestBuffer);
]]
local tapi32 = ffi.load("tapi32")
-- tapi32.lineGetRequest(hLineApp, dwRequestMode, lpRequestBuffer)
-- hLineApp : DWORD
-- dwRequestMode : DWORD
-- lpRequestBuffer : void* in/out
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。const koffi = require('koffi');
const lib = koffi.load('TAPI32.dll');
const lineGetRequest = lib.func('__stdcall', 'lineGetRequest', 'int32_t', ['uint32_t', 'uint32_t', 'void *']);
// lineGetRequest(hLineApp, dwRequestMode, lpRequestBuffer)
// hLineApp : DWORD -> 'uint32_t'
// dwRequestMode : DWORD -> 'uint32_t'
// lpRequestBuffer : void* in/out -> 'void *'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。const lib = Deno.dlopen("TAPI32.dll", {
lineGetRequest: { parameters: ["u32", "u32", "pointer"], result: "i32" },
});
// lib.symbols.lineGetRequest(hLineApp, dwRequestMode, lpRequestBuffer)
// hLineApp : DWORD -> "u32"
// dwRequestMode : DWORD -> "u32"
// lpRequestBuffer : void* in/out -> "pointer"
// 文字列は "buffer"。ANSI(-A) は new TextEncoder() で UTF-8/ANSI バイト列(末尾に \x00)を渡す。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。<?php
$ffi = FFI::cdef(<<<C
int32_t lineGetRequest(
uint32_t hLineApp,
uint32_t dwRequestMode,
void* lpRequestBuffer);
C, "TAPI32.dll");
// $ffi->lineGetRequest(hLineApp, dwRequestMode, lpRequestBuffer);
// hLineApp : DWORD
// dwRequestMode : DWORD
// lpRequestBuffer : void* 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 lineGetRequest(
int hLineApp, // DWORD
int dwRequestMode, // DWORD
Pointer lpRequestBuffer // void* in/out
);
}@[Link("tapi32")]
lib LibTAPI32
fun lineGetRequest = lineGetRequest(
hLineApp : UInt32, # DWORD
dwRequestMode : UInt32, # DWORD
lpRequestBuffer : Void* # void* 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 lineGetRequestNative = Int32 Function(Uint32, Uint32, Pointer<Void>);
typedef lineGetRequestDart = int Function(int, int, Pointer<Void>);
final lineGetRequest = DynamicLibrary.open('TAPI32.dll')
.lookupFunction<lineGetRequestNative, lineGetRequestDart>('lineGetRequest');
// hLineApp : DWORD -> Uint32
// dwRequestMode : DWORD -> Uint32
// lpRequestBuffer : void* in/out -> Pointer<Void>
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。{$mode objfpc}{$H+}
function lineGetRequest(
hLineApp: DWORD; // DWORD
dwRequestMode: DWORD; // DWORD
lpRequestBuffer: Pointer // void* in/out
): Integer; stdcall;
external 'TAPI32.dll' name 'lineGetRequest';import Foreign
import Foreign.C.Types
import Foreign.C.String
foreign import stdcall safe "lineGetRequest"
c_lineGetRequest :: Word32 -> Word32 -> Ptr () -> IO Int32
-- hLineApp : DWORD -> Word32
-- dwRequestMode : DWORD -> Word32
-- lpRequestBuffer : void* in/out -> Ptr ()
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。open Ctypes
open Foreign
let linegetrequest =
foreign "lineGetRequest"
(uint32_t @-> uint32_t @-> (ptr void) @-> returning int32_t)
(* hLineApp : DWORD -> uint32_t *)
(* dwRequestMode : DWORD -> uint32_t *)
(* lpRequestBuffer : void* 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 ("lineGetRequest" line-get-request :convention :stdcall) :int32
(h-line-app :uint32) ; DWORD
(dw-request-mode :uint32) ; DWORD
(lp-request-buffer :pointer)) ; void* in/out
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。use Win32::API;
my $lineGetRequest = Win32::API::More->new('TAPI32',
'int lineGetRequest(DWORD hLineApp, DWORD dwRequestMode, LPVOID lpRequestBuffer)');
# my $ret = $lineGetRequest->Call($hLineApp, $dwRequestMode, $lpRequestBuffer);
# hLineApp : DWORD -> DWORD
# dwRequestMode : DWORD -> DWORD
# lpRequestBuffer : void* in/out -> LPVOID
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。関連項目
- f lineGetRequestA (ANSI版) — 保留中の支援電話要求を取得する(ANSI版)。
- f lineGetRequestW (Unicode版) — 保留中の支援電話要求を取得する(Unicode版)。
- s LINEREQMAKECALL
- f tapiRequestMakeCallA — 発信を要求する関数のANSI版。