ホーム › Devices.Tapi › lineSetAppPriorityW

lineSetAppPriorityW

関数

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

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

シグネチャ

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

INT lineSetAppPriorityW(
    LPCWSTR lpszAppFilename,
    DWORD dwMediaMode,
    LINEEXTENSIONID* lpExtensionID,
    DWORD dwRequestMode,
    LPCWSTR lpszExtensionName,
    DWORD dwPriority
);

パラメーター

名前	型	方向	説明
lpszAppFilename	LPCWSTR	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	LPCWSTR	in	このパラメーターは無視されます。
dwPriority	DWORD	in	アプリケーションの新しい優先順位を示すパラメーターです。値 0 を渡すと、指定したメディアまたは要求モードの優先順位リストからアプリケーションが削除されます。元からリストに存在しなかった場合でも、エラーは発生しません。値 1 を渡すと、そのメディアまたは要求モードに対して最も優先順位の高いアプリケーションとして挿入されます。すでにリストに含まれている場合は、より優先順位の低い位置から削除されます。これら以外の値を指定するとエラーになります。

戻り値の型: INT

公式ドキュメント

lineSetAppPriorityW (Unicode) 関数 (tapi.h) は、アプリケーションがハンドオフ優先順位リスト内での自身の優先順位を設定できるようにします。

戻り値

要求が成功した場合は 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 ヘッダーは、UNICODE プリプロセッサ定数の定義に応じてこの関数の ANSI 版と Unicode 版を自動的に選択するエイリアスとして lineSetAppPriority を定義しています。エンコードに依存しないエイリアスを、エンコードに依存するコードと混在させて使用すると、不一致が生じてコンパイルエラーや実行時エラーの原因となる場合があります。詳細については、「Conventions for Function Prototypes」を参照してください。

出典・ライセンス: 上記「公式ドキュメント」の内容は 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 lineSetAppPriorityW(
    LPCWSTR lpszAppFilename,
    DWORD dwMediaMode,
    LINEEXTENSIONID* lpExtensionID,
    DWORD dwRequestMode,
    LPCWSTR lpszExtensionName,
    DWORD dwPriority
);

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

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

' lpszAppFilename : LPCWSTR
' dwMediaMode : DWORD
' lpExtensionID : LINEEXTENSIONID* in/out
' dwRequestMode : DWORD
' lpszExtensionName : LPCWSTR
' dwPriority : DWORD
Declare PtrSafe Function lineSetAppPriorityW Lib "tapi32" ( _
    ByVal lpszAppFilename As LongPtr, _
    ByVal dwMediaMode As Long, _
    ByVal lpExtensionID As LongPtr, _
    ByVal dwRequestMode As Long, _
    ByVal lpszExtensionName As LongPtr, _
    ByVal dwPriority As Long) 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

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

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('TAPI32.dll')
lineSetAppPriorityW = Fiddle::Function.new(
  lib['lineSetAppPriorityW'],
  [
    Fiddle::TYPE_VOIDP,  # lpszAppFilename : LPCWSTR
    -Fiddle::TYPE_INT,  # dwMediaMode : DWORD
    Fiddle::TYPE_VOIDP,  # lpExtensionID : LINEEXTENSIONID* in/out
    -Fiddle::TYPE_INT,  # dwRequestMode : DWORD
    Fiddle::TYPE_VOIDP,  # lpszExtensionName : LPCWSTR
    -Fiddle::TYPE_INT,  # dwPriority : DWORD
  ],
  Fiddle::TYPE_INT)
# Wide strings: pass str.encode("UTF-16LE") + "\x00\x00"

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

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

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

出力引数:

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