ホーム › Storage.FileSystem › GetTapeParameters

GetTapeParameters

関数

テープドライブやメディアのパラメータ情報を取得する。

DLLKERNEL32.dll呼出規約winapi対応OSWindows XP 以降

シグネチャ

// KERNEL32.dll
#include <windows.h>

DWORD GetTapeParameters(
    HANDLE hDevice,
    GET_TAPE_DRIVE_PARAMETERS_OPERATION dwOperation,
    DWORD* lpdwSize,
    void* lpTapeInformation
);

パラメーター

名前

型

方向

説明

hDevice

HANDLE

情報を取得する対象デバイスのハンドル。このハンドルは CreateFile 関数を使用して作成します。

dwOperation

GET_TAPE_DRIVE_PARAMETERS_OPERATION

要求する情報の種類。このパラメーターは次のいずれかの値である必要があります。

値	意味
GET_TAPE_DRIVE_INFORMATION 1	テープデバイスに関する情報を取得します。
GET_TAPE_MEDIA_INFORMATION 0	テープデバイス内のテープに関する情報を取得します。

lpdwSize

DWORD*

inout

lpTapeInformation パラメーターで指定されたバッファーのサイズ(バイト単位)を受け取る変数へのポインター。バッファーが小さすぎる場合、このパラメーターは必要なサイズを受け取ります。

lpTapeInformation

void*

out

要求された情報を格納する構造体へのポインター。dwOperation パラメーターが GET_TAPE_MEDIA_INFORMATION の場合、lpTapeInformation は TAPE_GET_MEDIA_PARAMETERS 構造体を指します。

dwOperation が GET_TAPE_DRIVE_INFORMATION の場合、lpTapeInformation は TAPE_GET_DRIVE_PARAMETERS 構造体を指します。

戻り値の型: DWORD

公式ドキュメント

テープまたはテープドライブを記述する情報を取得します。

戻り値

関数が成功した場合、戻り値は NO_ERROR です。

関数が失敗した場合、次のいずれかのエラーコードを返すことがあります。

エラーコード	説明
ERROR_BEGINNING_OF_MEDIA 1102L	メディアの先頭マーカーより前のデータにアクセスしようとして失敗しました。
ERROR_BUS_RESET 1111L	バス上でリセット状態が検出されました。
ERROR_DEVICE_NOT_PARTITIONED 1107L	テープのロード中にパーティション情報が見つかりませんでした。
ERROR_END_OF_MEDIA 1100L	操作中にテープの終端マーカーに到達しました。
ERROR_FILEMARK_DETECTED 1101L	操作中にファイルマークに到達しました。
ERROR_INVALID_BLOCK_LENGTH 1106L	マルチボリュームパーティション内の新しいテープでブロックサイズが正しくありません。
ERROR_MEDIA_CHANGED 1110L	ドライブ内にあったテープが交換または取り外されました。
ERROR_NO_DATA_DETECTED 1104L	操作中にデータの終端マーカーに到達しました。
ERROR_NO_MEDIA_IN_DRIVE 1112L	ドライブにメディアがありません。
ERROR_NOT_SUPPORTED 50L	テープドライバーが、要求された機能をサポートしていません。
ERROR_PARTITION_FAILURE 1105L	テープをパーティション分割できませんでした。
ERROR_SETMARK_DETECTED 1103L	操作中にセットマークに到達しました。
ERROR_UNABLE_TO_LOCK_MEDIA 1108L	取り出し機構をロックしようとして失敗しました。
ERROR_UNABLE_TO_UNLOAD_MEDIA 1109L	テープをアンロードしようとして失敗しました。
ERROR_WRITE_PROTECT 19L	メディアが書き込み禁止です。

解説(Remarks)

dwOperation パラメーターに GET_TAPE_DRIVE_INFORMATION 値を指定して GetTapeParameters 関数を呼び出したときに返されるブロックサイズの範囲値(最大値および最小値)は、ドライブの制限ではなくシステムの制限を示します。ただし、実際のブロックサイズの制限を決定するのは、テープドライブデバイスおよびドライブ内に存在するメディアです。したがって、アプリケーションは、dwOperation に GET_TAPE_DRIVE_INFORMATION を指定して取得した範囲に含まれるすべてのブロックサイズを設定できるとは限りません。

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

各言語での呼び出し定義

// KERNEL32.dll
#include <windows.h>

DWORD GetTapeParameters(
    HANDLE hDevice,
    GET_TAPE_DRIVE_PARAMETERS_OPERATION dwOperation,
    DWORD* lpdwSize,
    void* lpTapeInformation
);

[DllImport("KERNEL32.dll", ExactSpelling = true)]
static extern uint GetTapeParameters(
    IntPtr hDevice,   // HANDLE
    uint dwOperation,   // GET_TAPE_DRIVE_PARAMETERS_OPERATION
    ref uint lpdwSize,   // DWORD* in/out
    IntPtr lpTapeInformation   // void* out
);

<DllImport("KERNEL32.dll", ExactSpelling:=True)>
Public Shared Function GetTapeParameters(
    hDevice As IntPtr,   ' HANDLE
    dwOperation As UInteger,   ' GET_TAPE_DRIVE_PARAMETERS_OPERATION
    ByRef lpdwSize As UInteger,   ' DWORD* in/out
    lpTapeInformation As IntPtr   ' void* out
) As UInteger
End Function

' hDevice : HANDLE
' dwOperation : GET_TAPE_DRIVE_PARAMETERS_OPERATION
' lpdwSize : DWORD* in/out
' lpTapeInformation : void* out
Declare PtrSafe Function GetTapeParameters Lib "kernel32" ( _
    ByVal hDevice As LongPtr, _
    ByVal dwOperation As Long, _
    ByRef lpdwSize As Long, _
    ByVal lpTapeInformation As LongPtr) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。

import ctypes
from ctypes import wintypes

GetTapeParameters = ctypes.windll.kernel32.GetTapeParameters
GetTapeParameters.restype = wintypes.DWORD
GetTapeParameters.argtypes = [
    wintypes.HANDLE,  # hDevice : HANDLE
    wintypes.DWORD,  # dwOperation : GET_TAPE_DRIVE_PARAMETERS_OPERATION
    ctypes.POINTER(wintypes.DWORD),  # lpdwSize : DWORD* in/out
    ctypes.POINTER(None),  # lpTapeInformation : void* out
]

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('KERNEL32.dll')
GetTapeParameters = Fiddle::Function.new(
  lib['GetTapeParameters'],
  [
    Fiddle::TYPE_VOIDP,  # hDevice : HANDLE
    -Fiddle::TYPE_INT,  # dwOperation : GET_TAPE_DRIVE_PARAMETERS_OPERATION
    Fiddle::TYPE_VOIDP,  # lpdwSize : DWORD* in/out
    Fiddle::TYPE_VOIDP,  # lpTapeInformation : void* out
  ],
  -Fiddle::TYPE_INT)

#[link(name = "kernel32")]
extern "system" {
    fn GetTapeParameters(
        hDevice: *mut core::ffi::c_void,  // HANDLE
        dwOperation: u32,  // GET_TAPE_DRIVE_PARAMETERS_OPERATION
        lpdwSize: *mut u32,  // DWORD* in/out
        lpTapeInformation: *mut ()  // void* out
    ) -> u32;
}
// crates: windows-sys provides ready-made bindings for this API.

$sig = @"
[DllImport("KERNEL32.dll")]
public static extern uint GetTapeParameters(IntPtr hDevice, uint dwOperation, ref uint lpdwSize, IntPtr lpTapeInformation);
"@
$api = Add-Type -MemberDefinition $sig -Name 'KERNEL32_GetTapeParameters' -Namespace Win32 -PassThru
# $api::GetTapeParameters(hDevice, dwOperation, lpdwSize, lpTapeInformation)

#uselib "KERNEL32.dll"
#func global GetTapeParameters "GetTapeParameters" sptr, sptr, sptr, sptr
; GetTapeParameters hDevice, dwOperation, varptr(lpdwSize), lpTapeInformation   ; 戻り値は stat
; hDevice : HANDLE -> "sptr"
; dwOperation : GET_TAPE_DRIVE_PARAMETERS_OPERATION -> "sptr"
; lpdwSize : DWORD* in/out -> "sptr"
; lpTapeInformation : void* out -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。

出力引数:

#uselib "KERNEL32.dll"
#cfunc global GetTapeParameters "GetTapeParameters" sptr, int, var, sptr
; res = GetTapeParameters(hDevice, dwOperation, lpdwSize, lpTapeInformation)
; hDevice : HANDLE -> "sptr"
; dwOperation : GET_TAPE_DRIVE_PARAMETERS_OPERATION -> "int"
; lpdwSize : DWORD* in/out -> "var"
; lpTapeInformation : void* out -> "sptr"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。#uselib "KERNEL32.dll"
#cfunc global GetTapeParameters "GetTapeParameters" sptr, int, sptr, sptr
; res = GetTapeParameters(hDevice, dwOperation, varptr(lpdwSize), lpTapeInformation)
; hDevice : HANDLE -> "sptr"
; dwOperation : GET_TAPE_DRIVE_PARAMETERS_OPERATION -> "int"
; lpdwSize : DWORD* in/out -> "sptr"
; lpTapeInformation : void* out -> "sptr"
; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは varptr(変数))。