Win32 API 日本語リファレンス
ホームStorage.FileSystem › PrepareTape

PrepareTape

関数
テープのロードやアンロードなど準備操作を実行する。
DLLKERNEL32.dll呼出規約winapi対応OSWindows XP 以降

シグネチャ

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

DWORD PrepareTape(
    HANDLE hDevice,
    PREPARE_TAPE_OPERATION dwOperation,
    BOOL bImmediate
);

パラメーター

名前方向説明
hDeviceHANDLEinテープを準備するデバイスへのハンドル。このハンドルは CreateFile 関数を使用して作成します。
dwOperationPREPARE_TAPE_OPERATIONin

テープデバイスの準備操作。このパラメーターには次のいずれかの値を指定できます。

意味
TAPE_FORMAT
5L
テープの低レベルフォーマットを実行します。現在、この機能をサポートしているのは QIC117 デバイスのみです。
TAPE_LOAD
0L
テープをロードし、テープの先頭に移動します。
TAPE_LOCK
3L
誤ってテープが取り出されないように、テープの排出機構をロックします。
TAPE_TENSION
2L
テープを末尾まで移動させてから先頭に戻すことで、テンションを調整します。このオプションはすべてのデバイスでサポートされているわけではありません。サポートされていない場合、この値は無視されます。
TAPE_UNLOAD
1L
デバイスから取り出せるように、テープを先頭に移動します。アンロード操作が成功した後、デバイスはテープに再度アクセスしようとするアプリケーションに対して、テープが再びロードされるまでエラーを返します。
TAPE_UNLOCK
4L
テープの排出機構のロックを解除します。
bImmediateBOOLinこのパラメーターが TRUE の場合、関数は直ちに制御を返します。FALSE の場合、操作が完了するまで関数は制御を返しません。

戻り値の型: 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)

一部のテープデバイスは、特定のテープ操作をサポートしていません。テープデバイスのドキュメントを参照し、 GetTapeParameters 関数を使用してテープデバイスの機能を確認してください。

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

各言語での呼び出し定義

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

DWORD PrepareTape(
    HANDLE hDevice,
    PREPARE_TAPE_OPERATION dwOperation,
    BOOL bImmediate
);
[DllImport("KERNEL32.dll", ExactSpelling = true)]
static extern uint PrepareTape(
    IntPtr hDevice,   // HANDLE
    uint dwOperation,   // PREPARE_TAPE_OPERATION
    bool bImmediate   // BOOL
);
<DllImport("KERNEL32.dll", ExactSpelling:=True)>
Public Shared Function PrepareTape(
    hDevice As IntPtr,   ' HANDLE
    dwOperation As UInteger,   ' PREPARE_TAPE_OPERATION
    bImmediate As Boolean   ' BOOL
) As UInteger
End Function
' hDevice : HANDLE
' dwOperation : PREPARE_TAPE_OPERATION
' bImmediate : BOOL
Declare PtrSafe Function PrepareTape Lib "kernel32" ( _
    ByVal hDevice As LongPtr, _
    ByVal dwOperation As Long, _
    ByVal bImmediate As Long) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。
import ctypes
from ctypes import wintypes

PrepareTape = ctypes.windll.kernel32.PrepareTape
PrepareTape.restype = wintypes.DWORD
PrepareTape.argtypes = [
    wintypes.HANDLE,  # hDevice : HANDLE
    wintypes.DWORD,  # dwOperation : PREPARE_TAPE_OPERATION
    wintypes.BOOL,  # bImmediate : BOOL
]
require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('KERNEL32.dll')
PrepareTape = Fiddle::Function.new(
  lib['PrepareTape'],
  [
    Fiddle::TYPE_VOIDP,  # hDevice : HANDLE
    -Fiddle::TYPE_INT,  # dwOperation : PREPARE_TAPE_OPERATION
    Fiddle::TYPE_INT,  # bImmediate : BOOL
  ],
  -Fiddle::TYPE_INT)
#[link(name = "kernel32")]
extern "system" {
    fn PrepareTape(
        hDevice: *mut core::ffi::c_void,  // HANDLE
        dwOperation: u32,  // PREPARE_TAPE_OPERATION
        bImmediate: i32  // BOOL
    ) -> u32;
}
// crates: windows-sys provides ready-made bindings for this API.
$sig = @"
[DllImport("KERNEL32.dll")]
public static extern uint PrepareTape(IntPtr hDevice, uint dwOperation, bool bImmediate);
"@
$api = Add-Type -MemberDefinition $sig -Name 'KERNEL32_PrepareTape' -Namespace Win32 -PassThru
# $api::PrepareTape(hDevice, dwOperation, bImmediate)
#uselib "KERNEL32.dll"
#func global PrepareTape "PrepareTape" sptr, sptr, sptr
; PrepareTape hDevice, dwOperation, bImmediate   ; 戻り値は stat
; hDevice : HANDLE -> "sptr"
; dwOperation : PREPARE_TAPE_OPERATION -> "sptr"
; bImmediate : BOOL -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
#uselib "KERNEL32.dll"
#cfunc global PrepareTape "PrepareTape" sptr, int, int
; res = PrepareTape(hDevice, dwOperation, bImmediate)
; hDevice : HANDLE -> "sptr"
; dwOperation : PREPARE_TAPE_OPERATION -> "int"
; bImmediate : BOOL -> "int"
; DWORD PrepareTape(HANDLE hDevice, PREPARE_TAPE_OPERATION dwOperation, BOOL bImmediate)
#uselib "KERNEL32.dll"
#cfunc global PrepareTape "PrepareTape" intptr, int, int
; res = PrepareTape(hDevice, dwOperation, bImmediate)
; hDevice : HANDLE -> "intptr"
; dwOperation : PREPARE_TAPE_OPERATION -> "int"
; bImmediate : BOOL -> "int"
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	kernel32 = windows.NewLazySystemDLL("KERNEL32.dll")
	procPrepareTape = kernel32.NewProc("PrepareTape")
)

// hDevice (HANDLE), dwOperation (PREPARE_TAPE_OPERATION), bImmediate (BOOL)
r1, _, err := procPrepareTape.Call(
	uintptr(hDevice),
	uintptr(dwOperation),
	uintptr(bImmediate),
)
_ = err  // syscall.Errno (valid when the call sets last-error)
_ = r1   // DWORD
function PrepareTape(
  hDevice: THandle;   // HANDLE
  dwOperation: DWORD;   // PREPARE_TAPE_OPERATION
  bImmediate: BOOL   // BOOL
): DWORD; stdcall;
  external 'KERNEL32.dll' name 'PrepareTape';
result := DllCall("KERNEL32\PrepareTape"
    , "Ptr", hDevice   ; HANDLE
    , "UInt", dwOperation   ; PREPARE_TAPE_OPERATION
    , "Int", bImmediate   ; BOOL
    , "UInt")   ; return: DWORD
●PrepareTape(hDevice, dwOperation, bImmediate) = DLL("KERNEL32.dll", "dword PrepareTape(void*, dword, bool)")
# 呼び出し: PrepareTape(hDevice, dwOperation, bImmediate)
# hDevice : HANDLE -> "void*"
# dwOperation : PREPARE_TAPE_OPERATION -> "dword"
# bImmediate : BOOL -> "bool"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。
const std = @import("std");

extern "kernel32" fn PrepareTape(
    hDevice: ?*anyopaque, // HANDLE
    dwOperation: u32, // PREPARE_TAPE_OPERATION
    bImmediate: i32 // BOOL
) callconv(std.os.windows.WINAPI) u32;
proc PrepareTape(
    hDevice: pointer,  # HANDLE
    dwOperation: uint32,  # PREPARE_TAPE_OPERATION
    bImmediate: int32  # BOOL
): uint32 {.importc: "PrepareTape", stdcall, dynlib: "KERNEL32.dll".}
pragma(lib, "kernel32");
extern(Windows)
uint PrepareTape(
    void* hDevice,   // HANDLE
    uint dwOperation,   // PREPARE_TAPE_OPERATION
    int bImmediate   // BOOL
);
ccall((:PrepareTape, "KERNEL32.dll"), stdcall, UInt32,
      (Ptr{Cvoid}, UInt32, Int32),
      hDevice, dwOperation, bImmediate)
# hDevice : HANDLE -> Ptr{Cvoid}
# dwOperation : PREPARE_TAPE_OPERATION -> UInt32
# bImmediate : BOOL -> Int32
# stdcall は 32bit のみ意味を持つ(x64 では無視)。
local ffi = require("ffi")
ffi.cdef[[
uint32_t PrepareTape(
    void* hDevice,
    uint32_t dwOperation,
    int32_t bImmediate);
]]
local kernel32 = ffi.load("kernel32")
-- kernel32.PrepareTape(hDevice, dwOperation, bImmediate)
-- hDevice : HANDLE
-- dwOperation : PREPARE_TAPE_OPERATION
-- bImmediate : BOOL
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
const koffi = require('koffi');
const lib = koffi.load('KERNEL32.dll');
const PrepareTape = lib.func('__stdcall', 'PrepareTape', 'uint32_t', ['void *', 'uint32_t', 'int32_t']);
// PrepareTape(hDevice, dwOperation, bImmediate)
// hDevice : HANDLE -> 'void *'
// dwOperation : PREPARE_TAPE_OPERATION -> 'uint32_t'
// bImmediate : BOOL -> 'int32_t'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。
const lib = Deno.dlopen("KERNEL32.dll", {
  PrepareTape: { parameters: ["pointer", "u32", "i32"], result: "u32" },
});
// lib.symbols.PrepareTape(hDevice, dwOperation, bImmediate)
// hDevice : HANDLE -> "pointer"
// dwOperation : PREPARE_TAPE_OPERATION -> "u32"
// bImmediate : BOOL -> "i32"
// 文字列引数は "buffer"(NUL 終端のバイト列を Uint8Array で渡す)。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。
<?php
$ffi = FFI::cdef(<<<C
uint32_t PrepareTape(
    void* hDevice,
    uint32_t dwOperation,
    int32_t bImmediate);
C, "KERNEL32.dll");
// $ffi->PrepareTape(hDevice, dwOperation, bImmediate);
// hDevice : HANDLE
// dwOperation : PREPARE_TAPE_OPERATION
// bImmediate : BOOL
// 構造体/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 Kernel32 extends StdCallLibrary {
    Kernel32 INSTANCE = Native.load("kernel32", Kernel32.class);
    int PrepareTape(
        Pointer hDevice,   // HANDLE
        int dwOperation,   // PREPARE_TAPE_OPERATION
        boolean bImmediate   // BOOL
    );
}
@[Link("kernel32")]
lib LibKERNEL32
  fun PrepareTape = PrepareTape(
    hDevice : Void*,   # HANDLE
    dwOperation : UInt32,   # PREPARE_TAPE_OPERATION
    bImmediate : Int32   # BOOL
  ) : UInt32
end
# 構造体/GUID/enum は lib 内に対応する型定義が必要。
# 呼出規約: x64 は規約統一のため OK。x86(32bit)は WINAPI=stdcall だが Crystal の fun に stdcall 付与構文がなく非対応。
import 'dart:ffi';
import 'package:ffi/ffi.dart';

typedef PrepareTapeNative = Uint32 Function(Pointer<Void>, Uint32, Int32);
typedef PrepareTapeDart = int Function(Pointer<Void>, int, int);
final PrepareTape = DynamicLibrary.open('KERNEL32.dll')
    .lookupFunction<PrepareTapeNative, PrepareTapeDart>('PrepareTape');
// hDevice : HANDLE -> Pointer<Void>
// dwOperation : PREPARE_TAPE_OPERATION -> Uint32
// bImmediate : BOOL -> Int32
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function PrepareTape(
  hDevice: THandle;   // HANDLE
  dwOperation: DWORD;   // PREPARE_TAPE_OPERATION
  bImmediate: BOOL   // BOOL
): DWORD; stdcall;
  external 'KERNEL32.dll' name 'PrepareTape';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "PrepareTape"
  c_PrepareTape :: Ptr () -> Word32 -> CInt -> IO Word32
-- hDevice : HANDLE -> Ptr ()
-- dwOperation : PREPARE_TAPE_OPERATION -> Word32
-- bImmediate : BOOL -> CInt
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let preparetape =
  foreign "PrepareTape"
    ((ptr void) @-> uint32_t @-> int32_t @-> returning uint32_t)
(* hDevice : HANDLE -> (ptr void) *)
(* dwOperation : PREPARE_TAPE_OPERATION -> uint32_t *)
(* bImmediate : BOOL -> int32_t *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)
(cffi:define-foreign-library kernel32 (t "KERNEL32.dll"))
(cffi:use-foreign-library kernel32)

(cffi:defcfun ("PrepareTape" prepare-tape :convention :stdcall) :uint32
  (h-device :pointer)   ; HANDLE
  (dw-operation :uint32)   ; PREPARE_TAPE_OPERATION
  (b-immediate :int32))   ; BOOL
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $PrepareTape = Win32::API::More->new('KERNEL32',
    'DWORD PrepareTape(HANDLE hDevice, DWORD dwOperation, BOOL bImmediate)');
# my $ret = $PrepareTape->Call($hDevice, $dwOperation, $bImmediate);
# hDevice : HANDLE -> HANDLE
# dwOperation : PREPARE_TAPE_OPERATION -> DWORD
# bImmediate : BOOL -> BOOL
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。

関連項目

公式の関連項目
使用する型