ホーム › Storage.FileSystem › EraseTape
EraseTape
関数テープデバイスの内容を消去する。
シグネチャ
// KERNEL32.dll
#include <windows.h>
DWORD EraseTape(
HANDLE hDevice,
ERASE_TAPE_TYPE dwEraseType,
BOOL bImmediate
);パラメーター
| 名前 | 型 | 方向 | 説明 | ||||||
|---|---|---|---|---|---|---|---|---|---|
| hDevice | HANDLE | in | テープを消去するデバイスへのハンドル。このハンドルは CreateFile 関数を使用して作成します。 | ||||||
| dwEraseType | ERASE_TAPE_TYPE | in | 消去方式。このパラメーターには次のいずれかの値を指定できます。
| ||||||
| bImmediate | BOOL | in | このパラメーターが TRUE の場合、関数はただちに制御を返します。FALSE の場合、関数は消去操作が完了するまで制御を返しません。 |
戻り値の型: DWORD
公式ドキュメント
テープの全体または一部を消去します。
戻り値
関数が成功すると、戻り値は NO_ERROR です。
関数が失敗した場合は、次のいずれかのエラーコードを返すことがあります。
| エラーコード | 説明 |
|---|---|
|
メディア先端マーカーより前のデータにアクセスしようとして失敗しました。 |
|
バス上でリセット状態が検出されました。 |
| テープのロード中にパーティション情報が見つかりませんでした。 | |
|
操作中にテープ終端マーカーに到達しました。 |
|
操作中にファイルマークに到達しました。 |
| マルチボリュームパーティション内の新しいテープでブロックサイズが正しくありません。 | |
|
ドライブ内にあったテープが交換または取り外されました。 |
|
操作中にデータ終端マーカーに到達しました。 |
|
ドライブにメディアがありません。 |
| テープドライバーが要求された機能をサポートしていません。 | |
|
テープをパーティション分割できませんでした。 |
|
操作中にセットマークに到達しました。 |
| 排出機構をロックしようとして失敗しました。 | |
| テープをアンロードしようとして失敗しました。 | |
| メディアは書き込み禁止になっています。 |
解説(Remarks)
一部のテープデバイスは特定のテープ操作をサポートしていません。お使いのテープデバイスの機能を確認するには、テープデバイスのドキュメントを参照し、 GetTapeParameters 関数を使用してください。
出典・ライセンス: 上記「公式ドキュメント」の内容は Microsoft の Win32 API ドキュメント(MicrosoftDocs/sdk-api)を日本語に翻訳・改変したものです。© Microsoft Corporation. CC BY 4.0 で提供。
Microsoft 公式リファレンス: 英語 (en-us) · 日本語 (ja-jp) · 原文ソース (GitHub)
Microsoft 公式リファレンス: 英語 (en-us) · 日本語 (ja-jp) · 原文ソース (GitHub)
各言語での呼び出し定義
// KERNEL32.dll
#include <windows.h>
DWORD EraseTape(
HANDLE hDevice,
ERASE_TAPE_TYPE dwEraseType,
BOOL bImmediate
);[DllImport("KERNEL32.dll", ExactSpelling = true)]
static extern uint EraseTape(
IntPtr hDevice, // HANDLE
uint dwEraseType, // ERASE_TAPE_TYPE
bool bImmediate // BOOL
);<DllImport("KERNEL32.dll", ExactSpelling:=True)>
Public Shared Function EraseTape(
hDevice As IntPtr, ' HANDLE
dwEraseType As UInteger, ' ERASE_TAPE_TYPE
bImmediate As Boolean ' BOOL
) As UInteger
End Function' hDevice : HANDLE
' dwEraseType : ERASE_TAPE_TYPE
' bImmediate : BOOL
Declare PtrSafe Function EraseTape Lib "kernel32" ( _
ByVal hDevice As LongPtr, _
ByVal dwEraseType 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
EraseTape = ctypes.windll.kernel32.EraseTape
EraseTape.restype = wintypes.DWORD
EraseTape.argtypes = [
wintypes.HANDLE, # hDevice : HANDLE
wintypes.DWORD, # dwEraseType : ERASE_TAPE_TYPE
wintypes.BOOL, # bImmediate : BOOL
]require 'fiddle'
require 'fiddle/import'
lib = Fiddle.dlopen('KERNEL32.dll')
EraseTape = Fiddle::Function.new(
lib['EraseTape'],
[
Fiddle::TYPE_VOIDP, # hDevice : HANDLE
-Fiddle::TYPE_INT, # dwEraseType : ERASE_TAPE_TYPE
Fiddle::TYPE_INT, # bImmediate : BOOL
],
-Fiddle::TYPE_INT)#[link(name = "kernel32")]
extern "system" {
fn EraseTape(
hDevice: *mut core::ffi::c_void, // HANDLE
dwEraseType: u32, // ERASE_TAPE_TYPE
bImmediate: i32 // BOOL
) -> u32;
}
// crates: windows-sys provides ready-made bindings for this API.$sig = @"
[DllImport("KERNEL32.dll")]
public static extern uint EraseTape(IntPtr hDevice, uint dwEraseType, bool bImmediate);
"@
$api = Add-Type -MemberDefinition $sig -Name 'KERNEL32_EraseTape' -Namespace Win32 -PassThru
# $api::EraseTape(hDevice, dwEraseType, bImmediate)#uselib "KERNEL32.dll"
#func global EraseTape "EraseTape" sptr, sptr, sptr
; EraseTape hDevice, dwEraseType, bImmediate ; 戻り値は stat
; hDevice : HANDLE -> "sptr"
; dwEraseType : ERASE_TAPE_TYPE -> "sptr"
; bImmediate : BOOL -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。#uselib "KERNEL32.dll"
#cfunc global EraseTape "EraseTape" sptr, int, int
; res = EraseTape(hDevice, dwEraseType, bImmediate)
; hDevice : HANDLE -> "sptr"
; dwEraseType : ERASE_TAPE_TYPE -> "int"
; bImmediate : BOOL -> "int"; DWORD EraseTape(HANDLE hDevice, ERASE_TAPE_TYPE dwEraseType, BOOL bImmediate)
#uselib "KERNEL32.dll"
#cfunc global EraseTape "EraseTape" intptr, int, int
; res = EraseTape(hDevice, dwEraseType, bImmediate)
; hDevice : HANDLE -> "intptr"
; dwEraseType : ERASE_TAPE_TYPE -> "int"
; bImmediate : BOOL -> "int"import (
"golang.org/x/sys/windows"
"unsafe"
)
var (
kernel32 = windows.NewLazySystemDLL("KERNEL32.dll")
procEraseTape = kernel32.NewProc("EraseTape")
)
// hDevice (HANDLE), dwEraseType (ERASE_TAPE_TYPE), bImmediate (BOOL)
r1, _, err := procEraseTape.Call(
uintptr(hDevice),
uintptr(dwEraseType),
uintptr(bImmediate),
)
_ = err // syscall.Errno (valid when the call sets last-error)
_ = r1 // DWORDfunction EraseTape(
hDevice: THandle; // HANDLE
dwEraseType: DWORD; // ERASE_TAPE_TYPE
bImmediate: BOOL // BOOL
): DWORD; stdcall;
external 'KERNEL32.dll' name 'EraseTape';result := DllCall("KERNEL32\EraseTape"
, "Ptr", hDevice ; HANDLE
, "UInt", dwEraseType ; ERASE_TAPE_TYPE
, "Int", bImmediate ; BOOL
, "UInt") ; return: DWORD●EraseTape(hDevice, dwEraseType, bImmediate) = DLL("KERNEL32.dll", "dword EraseTape(void*, dword, bool)")
# 呼び出し: EraseTape(hDevice, dwEraseType, bImmediate)
# hDevice : HANDLE -> "void*"
# dwEraseType : ERASE_TAPE_TYPE -> "dword"
# bImmediate : BOOL -> "bool"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。const std = @import("std");
extern "kernel32" fn EraseTape(
hDevice: ?*anyopaque, // HANDLE
dwEraseType: u32, // ERASE_TAPE_TYPE
bImmediate: i32 // BOOL
) callconv(std.os.windows.WINAPI) u32;proc EraseTape(
hDevice: pointer, # HANDLE
dwEraseType: uint32, # ERASE_TAPE_TYPE
bImmediate: int32 # BOOL
): uint32 {.importc: "EraseTape", stdcall, dynlib: "KERNEL32.dll".}pragma(lib, "kernel32");
extern(Windows)
uint EraseTape(
void* hDevice, // HANDLE
uint dwEraseType, // ERASE_TAPE_TYPE
int bImmediate // BOOL
);ccall((:EraseTape, "KERNEL32.dll"), stdcall, UInt32,
(Ptr{Cvoid}, UInt32, Int32),
hDevice, dwEraseType, bImmediate)
# hDevice : HANDLE -> Ptr{Cvoid}
# dwEraseType : ERASE_TAPE_TYPE -> UInt32
# bImmediate : BOOL -> Int32
# stdcall は 32bit のみ意味を持つ(x64 では無視)。local ffi = require("ffi")
ffi.cdef[[
uint32_t EraseTape(
void* hDevice,
uint32_t dwEraseType,
int32_t bImmediate);
]]
local kernel32 = ffi.load("kernel32")
-- kernel32.EraseTape(hDevice, dwEraseType, bImmediate)
-- hDevice : HANDLE
-- dwEraseType : ERASE_TAPE_TYPE
-- bImmediate : BOOL
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。const koffi = require('koffi');
const lib = koffi.load('KERNEL32.dll');
const EraseTape = lib.func('__stdcall', 'EraseTape', 'uint32_t', ['void *', 'uint32_t', 'int32_t']);
// EraseTape(hDevice, dwEraseType, bImmediate)
// hDevice : HANDLE -> 'void *'
// dwEraseType : ERASE_TAPE_TYPE -> 'uint32_t'
// bImmediate : BOOL -> 'int32_t'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。const lib = Deno.dlopen("KERNEL32.dll", {
EraseTape: { parameters: ["pointer", "u32", "i32"], result: "u32" },
});
// lib.symbols.EraseTape(hDevice, dwEraseType, bImmediate)
// hDevice : HANDLE -> "pointer"
// dwEraseType : ERASE_TAPE_TYPE -> "u32"
// bImmediate : BOOL -> "i32"
// 文字列引数は "buffer"(NUL 終端のバイト列を Uint8Array で渡す)。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。<?php
$ffi = FFI::cdef(<<<C
uint32_t EraseTape(
void* hDevice,
uint32_t dwEraseType,
int32_t bImmediate);
C, "KERNEL32.dll");
// $ffi->EraseTape(hDevice, dwEraseType, bImmediate);
// hDevice : HANDLE
// dwEraseType : ERASE_TAPE_TYPE
// 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 EraseTape(
Pointer hDevice, // HANDLE
int dwEraseType, // ERASE_TAPE_TYPE
boolean bImmediate // BOOL
);
}@[Link("kernel32")]
lib LibKERNEL32
fun EraseTape = EraseTape(
hDevice : Void*, # HANDLE
dwEraseType : UInt32, # ERASE_TAPE_TYPE
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 EraseTapeNative = Uint32 Function(Pointer<Void>, Uint32, Int32);
typedef EraseTapeDart = int Function(Pointer<Void>, int, int);
final EraseTape = DynamicLibrary.open('KERNEL32.dll')
.lookupFunction<EraseTapeNative, EraseTapeDart>('EraseTape');
// hDevice : HANDLE -> Pointer<Void>
// dwEraseType : ERASE_TAPE_TYPE -> Uint32
// bImmediate : BOOL -> Int32
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。{$mode objfpc}{$H+}
function EraseTape(
hDevice: THandle; // HANDLE
dwEraseType: DWORD; // ERASE_TAPE_TYPE
bImmediate: BOOL // BOOL
): DWORD; stdcall;
external 'KERNEL32.dll' name 'EraseTape';import Foreign
import Foreign.C.Types
import Foreign.C.String
foreign import stdcall safe "EraseTape"
c_EraseTape :: Ptr () -> Word32 -> CInt -> IO Word32
-- hDevice : HANDLE -> Ptr ()
-- dwEraseType : ERASE_TAPE_TYPE -> Word32
-- bImmediate : BOOL -> CInt
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。open Ctypes
open Foreign
let erasetape =
foreign "EraseTape"
((ptr void) @-> uint32_t @-> int32_t @-> returning uint32_t)
(* hDevice : HANDLE -> (ptr void) *)
(* dwEraseType : ERASE_TAPE_TYPE -> 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 ("EraseTape" erase-tape :convention :stdcall) :uint32
(h-device :pointer) ; HANDLE
(dw-erase-type :uint32) ; ERASE_TAPE_TYPE
(b-immediate :int32)) ; BOOL
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。use Win32::API;
my $EraseTape = Win32::API::More->new('KERNEL32',
'DWORD EraseTape(HANDLE hDevice, DWORD dwEraseType, BOOL bImmediate)');
# my $ret = $EraseTape->Call($hDevice, $dwEraseType, $bImmediate);
# hDevice : HANDLE -> HANDLE
# dwEraseType : ERASE_TAPE_TYPE -> DWORD
# bImmediate : BOOL -> BOOL
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。関連項目
公式の関連項目
- f CreateFileW — ファイルやデバイスを作成または開いてハンドルを返す。
- f GetTapeParameters — テープドライブやメディアのパラメータ情報を取得する。
使用する型