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

lineGetRequestW

関数
保留中の支援電話要求を取得する(Unicode版)。
DLLTAPI32.dll文字セットUnicode (-W)呼出規約winapi
📘 Microsoft Learn (日本語) · English

シグネチャ

// TAPI32.dll  (Unicode / -W)
#include <windows.h>

INT lineGetRequestW(
    DWORD hLineApp,
    DWORD dwRequestMode,
    void* lpRequestBuffer
);

パラメーター

名前型方向説明
hLineAppDWORDinTAPI の回線部分に対するアプリケーション使用ハンドルです。
dwRequestModeDWORDin取得するリクエストの種類です。dwRequestMode には 1 つのビットしか設定できないことに注意してください。このパラメーターには、 LINEREQUESTMODE_ 定数のうち 1 つだけを使用します。
lpRequestBuffervoid*inout

リクエストのパラメーターが格納されるメモリバッファーへのポインターです。バッファーのサイズ、およびバッファーに格納されるデータの解釈方法は、リクエストモードによって異なります。アプリケーションが割り当てるバッファーは、リクエストを保持するのに十分なサイズであることが前提となります。

dwRequestMode が LINEREQUESTMODE_MAKECALL の場合は、リクエストバッファーの内容を LINEREQMAKECALL 構造体として解釈してください。

LINEREQUESTMODE_MEDIACALL は廃止されています。詳細については、tapiRequestMediaCall を参照してください。

戻り値の型: INT

公式ドキュメント

lineGetRequestW (Unicode) 関数 (tapi.h) は、指定されたリクエストモードに対する次の代理リクエストを取得します。

戻り値

リクエストが成功した場合は 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 によって再送されないため、無視してはなりません。

メモ

tapi.h ヘッダーは、UNICODE プリプロセッサ定数の定義に応じてこの関数の ANSI 版または Unicode 版を自動的に選択するエイリアスとして lineGetRequest を定義しています。エンコーディング中立でないコードでエンコーディング中立のエイリアスを使用すると、不一致が生じ、コンパイルエラーや実行時エラーの原因となる可能性があります。詳細については、「関数プロトタイプの規則」を参照してください。

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

各言語での呼び出し定義

// TAPI32.dll  (Unicode / -W)
#include <windows.h>

INT lineGetRequestW(
    DWORD hLineApp,
    DWORD dwRequestMode,
    void* lpRequestBuffer
);
[DllImport("TAPI32.dll", CharSet = CharSet.Unicode, ExactSpelling = true)]
static extern int lineGetRequestW(
    uint hLineApp,   // DWORD
    uint dwRequestMode,   // DWORD
    IntPtr lpRequestBuffer   // void* in/out
);
<DllImport("TAPI32.dll", CharSet:=CharSet.Unicode, ExactSpelling:=True)>
Public Shared Function lineGetRequestW(
    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 lineGetRequestW Lib "tapi32" ( _
    ByVal hLineApp As Long, _
    ByVal dwRequestMode As Long, _
    ByVal lpRequestBuffer As LongPtr) As Long
' Unicode(W): 文字列は ByVal As LongPtr とし StrPtr(unicodeStr) を渡す
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。
import ctypes
from ctypes import wintypes

lineGetRequestW = ctypes.windll.tapi32.lineGetRequestW
lineGetRequestW.restype = ctypes.c_int
lineGetRequestW.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')
lineGetRequestW = Fiddle::Function.new(
  lib['lineGetRequestW'],
  [
    -Fiddle::TYPE_INT,  # hLineApp : DWORD
    -Fiddle::TYPE_INT,  # dwRequestMode : DWORD
    Fiddle::TYPE_VOIDP,  # lpRequestBuffer : void* in/out
  ],
  Fiddle::TYPE_INT)
# Wide strings: pass str.encode("UTF-16LE") + "\x00\x00"
#[link(name = "tapi32")]
extern "system" {
    fn lineGetRequestW(
        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.Unicode)]
public static extern int lineGetRequestW(uint hLineApp, uint dwRequestMode, IntPtr lpRequestBuffer);
"@
$api = Add-Type -MemberDefinition $sig -Name 'TAPI32_lineGetRequestW' -Namespace Win32 -PassThru
# $api::lineGetRequestW(hLineApp, dwRequestMode, lpRequestBuffer)
#uselib "TAPI32.dll"
#func global lineGetRequestW "lineGetRequestW" wptr, wptr, wptr
; lineGetRequestW hLineApp, dwRequestMode, lpRequestBuffer   ; 戻り値は stat
; hLineApp : DWORD -> "wptr"
; dwRequestMode : DWORD -> "wptr"
; lpRequestBuffer : void* in/out -> "wptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
#uselib "TAPI32.dll"
#cfunc global lineGetRequestW "lineGetRequestW" int, int, sptr
; res = lineGetRequestW(hLineApp, dwRequestMode, lpRequestBuffer)
; hLineApp : DWORD -> "int"
; dwRequestMode : DWORD -> "int"
; lpRequestBuffer : void* in/out -> "sptr"
; INT lineGetRequestW(DWORD hLineApp, DWORD dwRequestMode, void* lpRequestBuffer)
#uselib "TAPI32.dll"
#cfunc global lineGetRequestW "lineGetRequestW" int, int, intptr
; res = lineGetRequestW(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")
	proclineGetRequestW = tapi32.NewProc("lineGetRequestW")
)

// hLineApp (DWORD), dwRequestMode (DWORD), lpRequestBuffer (void* in/out)
r1, _, err := proclineGetRequestW.Call(
	uintptr(hLineApp),
	uintptr(dwRequestMode),
	uintptr(lpRequestBuffer),
)
_ = err  // syscall.Errno (valid when the call sets last-error)
_ = r1   // INT
function lineGetRequestW(
  hLineApp: DWORD;   // DWORD
  dwRequestMode: DWORD;   // DWORD
  lpRequestBuffer: Pointer   // void* in/out
): Integer; stdcall;
  external 'TAPI32.dll' name 'lineGetRequestW';
result := DllCall("TAPI32\lineGetRequestW"
    , "UInt", hLineApp   ; DWORD
    , "UInt", dwRequestMode   ; DWORD
    , "Ptr", lpRequestBuffer   ; void* in/out
    , "Int")   ; return: INT
●lineGetRequestW(hLineApp, dwRequestMode, lpRequestBuffer) = DLL("TAPI32.dll", "int lineGetRequestW(dword, dword, void*)")
# 呼び出し: lineGetRequestW(hLineApp, dwRequestMode, lpRequestBuffer)
# hLineApp : DWORD -> "dword"
# dwRequestMode : DWORD -> "dword"
# lpRequestBuffer : void* in/out -> "void*"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。
# ※-W(Unicode)関数。なでしこ1はANSIのため -A 版の利用を推奨。
const std = @import("std");

extern "tapi32" fn lineGetRequestW(
    hLineApp: u32, // DWORD
    dwRequestMode: u32, // DWORD
    lpRequestBuffer: ?*anyopaque // void* in/out
) callconv(std.os.windows.WINAPI) i32;
// Unicode(-W): UTF-16LE のヌル終端バッファ([*c]const u16)を渡す。
proc lineGetRequestW(
    hLineApp: uint32,  # DWORD
    dwRequestMode: uint32,  # DWORD
    lpRequestBuffer: pointer  # void* in/out
): int32 {.importc: "lineGetRequestW", stdcall, dynlib: "TAPI32.dll".}
# Unicode(-W): WideCString は newWideCString("...") で生成。
pragma(lib, "tapi32");
extern(Windows)
int lineGetRequestW(
    uint hLineApp,   // DWORD
    uint dwRequestMode,   // DWORD
    void* lpRequestBuffer   // void* in/out
);
ccall((:lineGetRequestW, "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 では無視)。
# Unicode(-W): Cwstring には transcode(UInt16, "...") 等で UTF-16 を渡す。
local ffi = require("ffi")
ffi.cdef[[
int32_t lineGetRequestW(
    uint32_t hLineApp,
    uint32_t dwRequestMode,
    void* lpRequestBuffer);
]]
local tapi32 = ffi.load("tapi32")
-- tapi32.lineGetRequestW(hLineApp, dwRequestMode, lpRequestBuffer)
-- hLineApp : DWORD
-- dwRequestMode : DWORD
-- lpRequestBuffer : void* in/out
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
-- Unicode(-W): uint16_t* には UTF-16LE のバッファ(ffi.new("uint16_t[?]", ...))を渡す。
const koffi = require('koffi');
const lib = koffi.load('TAPI32.dll');
const lineGetRequestW = lib.func('__stdcall', 'lineGetRequestW', 'int32_t', ['uint32_t', 'uint32_t', 'void *']);
// lineGetRequestW(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", {
  lineGetRequestW: { parameters: ["u32", "u32", "pointer"], result: "i32" },
});
// lib.symbols.lineGetRequestW(hLineApp, dwRequestMode, lpRequestBuffer)
// hLineApp : DWORD -> "u32"
// dwRequestMode : DWORD -> "u32"
// lpRequestBuffer : void* in/out -> "pointer"
// 文字列は "buffer"。Unicode(-W) は new TextEncoder() ではなく UTF-16LE のバイト列(末尾に \x00\x00)を Uint8Array で渡す。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。
<?php
$ffi = FFI::cdef(<<<C
int32_t lineGetRequestW(
    uint32_t hLineApp,
    uint32_t dwRequestMode,
    void* lpRequestBuffer);
C, "TAPI32.dll");
// $ffi->lineGetRequestW(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.UNICODE_OPTIONS);
    int lineGetRequestW(
        int hLineApp,   // DWORD
        int dwRequestMode,   // DWORD
        Pointer lpRequestBuffer   // void* in/out
    );
}
// Unicode(-W): WString(入力)/char[](出力)で UTF-16 をマーシャリング。
@[Link("tapi32")]
lib LibTAPI32
  fun lineGetRequestW = lineGetRequestW(
    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 lineGetRequestWNative = Int32 Function(Uint32, Uint32, Pointer<Void>);
typedef lineGetRequestWDart = int Function(int, int, Pointer<Void>);
final lineGetRequestW = DynamicLibrary.open('TAPI32.dll')
    .lookupFunction<lineGetRequestWNative, lineGetRequestWDart>('lineGetRequestW');
// hLineApp : DWORD -> Uint32
// dwRequestMode : DWORD -> Uint32
// lpRequestBuffer : void* in/out -> Pointer<Void>
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function lineGetRequestW(
  hLineApp: DWORD;   // DWORD
  dwRequestMode: DWORD;   // DWORD
  lpRequestBuffer: Pointer   // void* in/out
): Integer; stdcall;
  external 'TAPI32.dll' name 'lineGetRequestW';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "lineGetRequestW"
  c_lineGetRequestW :: 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 linegetrequestw =
  foreign "lineGetRequestW"
    (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 ("lineGetRequestW" line-get-request-w :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 $lineGetRequestW = Win32::API::More->new('TAPI32',
    'int lineGetRequestW(DWORD hLineApp, DWORD dwRequestMode, LPVOID lpRequestBuffer)');
# my $ret = $lineGetRequestW->Call($hLineApp, $dwRequestMode, $lpRequestBuffer);
# hLineApp : DWORD -> DWORD
# dwRequestMode : DWORD -> DWORD
# lpRequestBuffer : void* in/out -> LPVOID
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。
# Unicode(-W): LPCWSTR/LPWSTR は Win32::API が UTF-16 変換を行う。

関連項目

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