ホーム › Media.Multimedia › capGetDriverDescriptionA

capGetDriverDescriptionA

関数

指定インデックスのキャプチャドライバの説明とバージョンを取得する(ANSI版)。

DLLAVICAP32.dll文字セットANSI (-A)呼出規約winapi対応OSWindows 2000 以降

シグネチャ

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

BOOL capGetDriverDescriptionA(
    DWORD wDriverIndex,
    LPSTR lpszName,
    INT cbName,
    LPSTR lpszVer,
    INT cbVer
);

パラメーター

名前	型	方向	説明
wDriverIndex	DWORD	in	キャプチャドライバーのインデックス。インデックスは 0 から 9 の範囲で指定できます。プラグアンドプレイのキャプチャドライバーが最初に列挙され、続いてレジストリに登録されているキャプチャドライバー、その後に SYSTEM.INI に記載されているキャプチャドライバーが列挙されます。
lpszName	LPSTR	out	キャプチャドライバー名に対応する、null で終わる文字列を格納するバッファーへのポインター。
cbName	INT	in	lpszName が指すバッファーの長さ(バイト単位)。
lpszVer	LPSTR	out	キャプチャドライバーの説明に対応する、null で終わる文字列を格納するバッファーへのポインター。
cbVer	INT	in	lpszVer が指すバッファーの長さ(バイト単位)。

戻り値の型: BOOL

公式ドキュメント

capGetDriverDescription 関数は、キャプチャドライバーのバージョン情報を取得します。(ANSI)

戻り値

成功した場合は TRUE を、それ以外の場合は FALSE を返します。

解説(Remarks)

情報の説明がバッファーより長い場合、説明は切り詰められます。返される文字列は常に null で終端されます。バッファーサイズが 0 の場合、対応する説明はコピーされません。

メモ

vfw.h ヘッダーは、UNICODE プリプロセッサ定数の定義に基づいて、この関数の ANSI 版または Unicode 版を自動的に選択するエイリアスとして capGetDriverDescription を定義しています。エンコーディング非依存のエイリアスと、エンコーディング非依存でないコードを混在させると、不一致が生じ、コンパイルエラーや実行時エラーの原因となる場合があります。詳細については、Conventions for Function Prototypes を参照してください。

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

各言語での呼び出し定義

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

BOOL capGetDriverDescriptionA(
    DWORD wDriverIndex,
    LPSTR lpszName,
    INT cbName,
    LPSTR lpszVer,
    INT cbVer
);

[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("AVICAP32.dll", CharSet = CharSet.Ansi, ExactSpelling = true)]
static extern bool capGetDriverDescriptionA(
    uint wDriverIndex,   // DWORD
    [MarshalAs(UnmanagedType.LPStr)] System.Text.StringBuilder lpszName,   // LPSTR out
    int cbName,   // INT
    [MarshalAs(UnmanagedType.LPStr)] System.Text.StringBuilder lpszVer,   // LPSTR out
    int cbVer   // INT
);

<DllImport("AVICAP32.dll", CharSet:=CharSet.Ansi, ExactSpelling:=True)>
Public Shared Function capGetDriverDescriptionA(
    wDriverIndex As UInteger,   ' DWORD
    <MarshalAs(UnmanagedType.LPStr)> lpszName As System.Text.StringBuilder,   ' LPSTR out
    cbName As Integer,   ' INT
    <MarshalAs(UnmanagedType.LPStr)> lpszVer As System.Text.StringBuilder,   ' LPSTR out
    cbVer As Integer   ' INT
) As <MarshalAs(UnmanagedType.Bool)> Boolean
End Function

' wDriverIndex : DWORD
' lpszName : LPSTR out
' cbName : INT
' lpszVer : LPSTR out
' cbVer : INT
Declare PtrSafe Function capGetDriverDescriptionA Lib "avicap32" ( _
    ByVal wDriverIndex As Long, _
    ByVal lpszName As String, _
    ByVal cbName As Long, _
    ByVal lpszVer As String, _
    ByVal cbVer As Long) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。

import ctypes
from ctypes import wintypes

capGetDriverDescriptionA = ctypes.windll.avicap32.capGetDriverDescriptionA
capGetDriverDescriptionA.restype = wintypes.BOOL
capGetDriverDescriptionA.argtypes = [
    wintypes.DWORD,  # wDriverIndex : DWORD
    wintypes.LPSTR,  # lpszName : LPSTR out
    ctypes.c_int,  # cbName : INT
    wintypes.LPSTR,  # lpszVer : LPSTR out
    ctypes.c_int,  # cbVer : INT
]

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('AVICAP32.dll')
capGetDriverDescriptionA = Fiddle::Function.new(
  lib['capGetDriverDescriptionA'],
  [
    -Fiddle::TYPE_INT,  # wDriverIndex : DWORD
    Fiddle::TYPE_VOIDP,  # lpszName : LPSTR out
    Fiddle::TYPE_INT,  # cbName : INT
    Fiddle::TYPE_VOIDP,  # lpszVer : LPSTR out
    Fiddle::TYPE_INT,  # cbVer : INT
  ],
  Fiddle::TYPE_INT)

#[link(name = "avicap32")]
extern "system" {
    fn capGetDriverDescriptionA(
        wDriverIndex: u32,  // DWORD
        lpszName: *mut u8,  // LPSTR out
        cbName: i32,  // INT
        lpszVer: *mut u8,  // LPSTR out
        cbVer: i32  // INT
    ) -> i32;
}
// crates: windows-sys provides ready-made bindings for this API.

$sig = @"
[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("AVICAP32.dll", CharSet = CharSet.Ansi)]
public static extern bool capGetDriverDescriptionA(uint wDriverIndex, [MarshalAs(UnmanagedType.LPStr)] System.Text.StringBuilder lpszName, int cbName, [MarshalAs(UnmanagedType.LPStr)] System.Text.StringBuilder lpszVer, int cbVer);
"@
$api = Add-Type -MemberDefinition $sig -Name 'AVICAP32_capGetDriverDescriptionA' -Namespace Win32 -PassThru
# $api::capGetDriverDescriptionA(wDriverIndex, lpszName, cbName, lpszVer, cbVer)

#uselib "AVICAP32.dll"
#func global capGetDriverDescriptionA "capGetDriverDescriptionA" sptr, sptr, sptr, sptr, sptr
; capGetDriverDescriptionA wDriverIndex, varptr(lpszName), cbName, varptr(lpszVer), cbVer   ; 戻り値は stat
; wDriverIndex : DWORD -> "sptr"
; lpszName : LPSTR out -> "sptr"
; cbName : INT -> "sptr"
; lpszVer : LPSTR out -> "sptr"
; cbVer : INT -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。

出力引数:

#uselib "AVICAP32.dll"
#cfunc global capGetDriverDescriptionA "capGetDriverDescriptionA" int, var, int, var, int
; res = capGetDriverDescriptionA(wDriverIndex, lpszName, cbName, lpszVer, cbVer)
; wDriverIndex : DWORD -> "int"
; lpszName : LPSTR out -> "var"
; cbName : INT -> "int"
; lpszVer : LPSTR out -> "var"
; cbVer : INT -> "int"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。#uselib "AVICAP32.dll"
#cfunc global capGetDriverDescriptionA "capGetDriverDescriptionA" int, sptr, int, sptr, int
; res = capGetDriverDescriptionA(wDriverIndex, varptr(lpszName), cbName, varptr(lpszVer), cbVer)
; wDriverIndex : DWORD -> "int"
; lpszName : LPSTR out -> "sptr"
; cbName : INT -> "int"
; lpszVer : LPSTR out -> "sptr"
; cbVer : INT -> "int"
; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは varptr(変数))。