ホーム › Devices.Tapi › lineSetAppPriorityA

lineSetAppPriorityA

関数

アプリのメディアモード別優先順位を設定する(ANSI版)。

DLLTAPI32.dll文字セットANSI (-A)呼出規約winapi

シグネチャ

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

INT lineSetAppPriorityA(
    LPCSTR lpszAppFilename,
    DWORD dwMediaMode,
    LINEEXTENSIONID* lpExtensionID,
    DWORD dwRequestMode,
    LPCSTR lpszExtensionName,
    DWORD dwPriority
);

パラメーター

名前	型	方向	説明
lpszAppFilename	LPCSTR	in	アプリケーションの実行可能モジュールのファイル名を、ディレクトリ情報を含まない形で格納する文字列へのポインター。TAPI バージョン 2.0 以降では、このパラメーターには長いファイル名形式または 8.3 形式のいずれかのファイル名を指定できます。
dwMediaMode	DWORD	in	アプリケーションの優先順位を設定する対象のメディアタイプ。値には LINEMEDIAMODE 定数のうち 1 つ以上を指定できます。Assisted Telephony 要求に対するアプリケーションの優先順位を設定するには、値 0 を使用します。
lpExtensionID	LINEEXTENSIONID*	inout	LINEEXTENSIONID 型の構造体へのポインター。このパラメーターは無視されます。
dwRequestMode	DWORD	in	このパラメーターの条件は次のとおりです。dwMediaMode パラメーターが 0 の場合、このパラメーターは優先順位を設定する対象の Assisted Telephony 要求モードを指定します。LINEREQUESTMODE_MAKECALL でなければなりません。dwMediaMode が 0 以外の場合、このパラメーターは無視されます。
lpszExtensionName	LPCSTR	in	このパラメーターは無視されます。
dwPriority	DWORD	in	アプリケーションの新しい優先順位を示すパラメーター。値 0 を渡すと、指定したメディアまたは要求モードの優先順位リストからアプリケーションが削除されます。リストに存在しなかった場合でもエラーは発生しません。値 1 を渡すと、そのメディアまたは要求モードで最も優先順位の高いアプリケーションとして挿入されます。既にリストに含まれている場合は、より優先順位の低い位置から削除されます。それ以外の値を指定するとエラーになります。

戻り値の型: INT

公式ドキュメント

特定のメディアタイプまたは Assisted Telephony 要求モードのハンドオフ優先順位リストにおいて、アプリケーションが自身の優先順位を設定したり、優先順位リストから自身を削除したりできるようにします。(lineSetAppPriorityA)

戻り値

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

LINEERR_INIFILECORRUPT、LINEERR_INVALREQUESTMODE、LINEERR_INVALAPPNAME、LINEERR_NOMEM、LINEERR_INVALMEDIAMODE、LINEERR_OPERATIONFAILED、LINEERR_INVALPARAM、LINEERR_RESOURCEUNAVAIL、LINEERR_INVALPOINTER。

解説(Remarks)

LINEERR_INVALMEDIAMODE が返された場合、dwMediaMode に指定された値が 0 ではなく、かつ LINEMEDIAMODE_ 定数のいずれでもないことを意味します。

この関数は、保存されている優先順位リストを更新します。テレフォニーシステムが初期化されている場合は、その時点で実行中のアプリケーションに対する現在の有効な優先順位も設定します。新しい優先順位は、次の着信呼び出し、またはメディアタイプに基づく lineHandoff から使用されます。

lineSetAppPriority で設定された優先順位は、システムの再起動や tapisrv の再起動をまたいで保持されます。lineOpen 関数は、呼び出しの優先順位を指定せずに回線を開きます。既定では、最初に lineOpen を呼び出したアプリケーションが最も優先順位の高いアプリケーションになります。

メモ

tapi.h ヘッダーは lineSetAppPriority を、UNICODE プリプロセッサ定数の定義に基づいて、この関数の ANSI 版または Unicode 版を自動的に選択するエイリアスとして定義しています。エンコーディング中立のエイリアスの使用と、エンコーディング中立でないコードを混在させると、不一致が生じ、コンパイルエラーや実行時エラーの原因となる場合があります。詳細については、「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 lineSetAppPriorityA(
    LPCSTR lpszAppFilename,
    DWORD dwMediaMode,
    LINEEXTENSIONID* lpExtensionID,
    DWORD dwRequestMode,
    LPCSTR lpszExtensionName,
    DWORD dwPriority
);

[DllImport("TAPI32.dll", CharSet = CharSet.Ansi, ExactSpelling = true)]
static extern int lineSetAppPriorityA(
    [MarshalAs(UnmanagedType.LPStr)] string lpszAppFilename,   // LPCSTR
    uint dwMediaMode,   // DWORD
    IntPtr lpExtensionID,   // LINEEXTENSIONID* in/out
    uint dwRequestMode,   // DWORD
    [MarshalAs(UnmanagedType.LPStr)] string lpszExtensionName,   // LPCSTR
    uint dwPriority   // DWORD
);

<DllImport("TAPI32.dll", CharSet:=CharSet.Ansi, ExactSpelling:=True)>
Public Shared Function lineSetAppPriorityA(
    <MarshalAs(UnmanagedType.LPStr)> lpszAppFilename As String,   ' LPCSTR
    dwMediaMode As UInteger,   ' DWORD
    lpExtensionID As IntPtr,   ' LINEEXTENSIONID* in/out
    dwRequestMode As UInteger,   ' DWORD
    <MarshalAs(UnmanagedType.LPStr)> lpszExtensionName As String,   ' LPCSTR
    dwPriority As UInteger   ' DWORD
) As Integer
End Function

' lpszAppFilename : LPCSTR
' dwMediaMode : DWORD
' lpExtensionID : LINEEXTENSIONID* in/out
' dwRequestMode : DWORD
' lpszExtensionName : LPCSTR
' dwPriority : DWORD
Declare PtrSafe Function lineSetAppPriorityA Lib "tapi32" ( _
    ByVal lpszAppFilename As String, _
    ByVal dwMediaMode As Long, _
    ByVal lpExtensionID As LongPtr, _
    ByVal dwRequestMode As Long, _
    ByVal lpszExtensionName As String, _
    ByVal dwPriority As Long) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。

import ctypes
from ctypes import wintypes

lineSetAppPriorityA = ctypes.windll.tapi32.lineSetAppPriorityA
lineSetAppPriorityA.restype = ctypes.c_int
lineSetAppPriorityA.argtypes = [
    wintypes.LPCSTR,  # lpszAppFilename : LPCSTR
    wintypes.DWORD,  # dwMediaMode : DWORD
    ctypes.c_void_p,  # lpExtensionID : LINEEXTENSIONID* in/out
    wintypes.DWORD,  # dwRequestMode : DWORD
    wintypes.LPCSTR,  # lpszExtensionName : LPCSTR
    wintypes.DWORD,  # dwPriority : DWORD
]

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('TAPI32.dll')
lineSetAppPriorityA = Fiddle::Function.new(
  lib['lineSetAppPriorityA'],
  [
    Fiddle::TYPE_VOIDP,  # lpszAppFilename : LPCSTR
    -Fiddle::TYPE_INT,  # dwMediaMode : DWORD
    Fiddle::TYPE_VOIDP,  # lpExtensionID : LINEEXTENSIONID* in/out
    -Fiddle::TYPE_INT,  # dwRequestMode : DWORD
    Fiddle::TYPE_VOIDP,  # lpszExtensionName : LPCSTR
    -Fiddle::TYPE_INT,  # dwPriority : DWORD
  ],
  Fiddle::TYPE_INT)

#[link(name = "tapi32")]
extern "system" {
    fn lineSetAppPriorityA(
        lpszAppFilename: *const u8,  // LPCSTR
        dwMediaMode: u32,  // DWORD
        lpExtensionID: *mut LINEEXTENSIONID,  // LINEEXTENSIONID* in/out
        dwRequestMode: u32,  // DWORD
        lpszExtensionName: *const u8,  // LPCSTR
        dwPriority: u32  // DWORD
    ) -> i32;
}
// crates: windows-sys provides ready-made bindings for this API.

$sig = @"
[DllImport("TAPI32.dll", CharSet = CharSet.Ansi)]
public static extern int lineSetAppPriorityA([MarshalAs(UnmanagedType.LPStr)] string lpszAppFilename, uint dwMediaMode, IntPtr lpExtensionID, uint dwRequestMode, [MarshalAs(UnmanagedType.LPStr)] string lpszExtensionName, uint dwPriority);
"@
$api = Add-Type -MemberDefinition $sig -Name 'TAPI32_lineSetAppPriorityA' -Namespace Win32 -PassThru
# $api::lineSetAppPriorityA(lpszAppFilename, dwMediaMode, lpExtensionID, dwRequestMode, lpszExtensionName, dwPriority)

#uselib "TAPI32.dll"
#func global lineSetAppPriorityA "lineSetAppPriorityA" sptr, sptr, sptr, sptr, sptr, sptr
; lineSetAppPriorityA lpszAppFilename, dwMediaMode, varptr(lpExtensionID), dwRequestMode, lpszExtensionName, dwPriority   ; 戻り値は stat
; lpszAppFilename : LPCSTR -> "sptr"
; dwMediaMode : DWORD -> "sptr"
; lpExtensionID : LINEEXTENSIONID* in/out -> "sptr"
; dwRequestMode : DWORD -> "sptr"
; lpszExtensionName : LPCSTR -> "sptr"
; dwPriority : DWORD -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。

出力引数:

#uselib "TAPI32.dll"
#cfunc global lineSetAppPriorityA "lineSetAppPriorityA" str, int, var, int, str, int
; res = lineSetAppPriorityA(lpszAppFilename, dwMediaMode, lpExtensionID, dwRequestMode, lpszExtensionName, dwPriority)
; lpszAppFilename : LPCSTR -> "str"
; dwMediaMode : DWORD -> "int"
; lpExtensionID : LINEEXTENSIONID* in/out -> "var"
; dwRequestMode : DWORD -> "int"
; lpszExtensionName : LPCSTR -> "str"
; dwPriority : DWORD -> "int"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。#uselib "TAPI32.dll"
#cfunc global lineSetAppPriorityA "lineSetAppPriorityA" str, int, sptr, int, str, int
; res = lineSetAppPriorityA(lpszAppFilename, dwMediaMode, varptr(lpExtensionID), dwRequestMode, lpszExtensionName, dwPriority)
; lpszAppFilename : LPCSTR -> "str"
; dwMediaMode : DWORD -> "int"
; lpExtensionID : LINEEXTENSIONID* in/out -> "sptr"
; dwRequestMode : DWORD -> "int"
; lpszExtensionName : LPCSTR -> "str"
; dwPriority : DWORD -> "int"
; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは varptr(変数))。