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

WriteTapemark

関数
テープに指定種類のテープマークを書き込む。
DLLKERNEL32.dll呼出規約winapi対応OSWindows XP 以降

シグネチャ

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

DWORD WriteTapemark(
    HANDLE hDevice,
    TAPEMARK_TYPE dwTapemarkType,
    DWORD dwTapemarkCount,
    BOOL bImmediate
);

パラメーター

名前方向説明
hDeviceHANDLEinテープマークを書き込むデバイスへのハンドル。このハンドルは CreateFile 関数を使用して作成されます。
dwTapemarkTypeTAPEMARK_TYPEin

書き込むテープマークの種類。このパラメーターには、次のいずれかの値を指定できます。

意味
TAPE_FILEMARKS
1L
dwTapemarkCount パラメーターで指定した数のファイルマークを書き込みます。
TAPE_LONG_FILEMARKS
3L
dwTapemarkCount で指定した数のロングファイルマークを書き込みます。
TAPE_SETMARKS
0L
dwTapemarkCount で指定した数のセットマークを書き込みます。
TAPE_SHORT_FILEMARKS
2L
dwTapemarkCount で指定した数のショートファイルマークを書き込みます。
dwTapemarkCountDWORDin書き込むテープマークの数。
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)

ファイルマーク、セットマーク、ショートファイルマーク、ロングファイルマークは、テープの線形構成を示す特別な記録要素です。これらのマークにはユーザーデータは含まれません。ファイルマークは最も一般的なマークであり、セットマークはファイルマークでは得られない階層構造を提供します。

ショートファイルマークには短い消去ギャップが含まれており、パーティションの先頭または以前のロングファイルマークから書き込み操作を行わない限り、上書きできません。

ロングファイルマークには長い消去ギャップが含まれており、アプリケーションはファイルマークの先頭にテープを位置付けて、そのファイルマークと消去ギャップを上書きできます。

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

各言語での呼び出し定義

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

DWORD WriteTapemark(
    HANDLE hDevice,
    TAPEMARK_TYPE dwTapemarkType,
    DWORD dwTapemarkCount,
    BOOL bImmediate
);
[DllImport("KERNEL32.dll", ExactSpelling = true)]
static extern uint WriteTapemark(
    IntPtr hDevice,   // HANDLE
    uint dwTapemarkType,   // TAPEMARK_TYPE
    uint dwTapemarkCount,   // DWORD
    bool bImmediate   // BOOL
);
<DllImport("KERNEL32.dll", ExactSpelling:=True)>
Public Shared Function WriteTapemark(
    hDevice As IntPtr,   ' HANDLE
    dwTapemarkType As UInteger,   ' TAPEMARK_TYPE
    dwTapemarkCount As UInteger,   ' DWORD
    bImmediate As Boolean   ' BOOL
) As UInteger
End Function
' hDevice : HANDLE
' dwTapemarkType : TAPEMARK_TYPE
' dwTapemarkCount : DWORD
' bImmediate : BOOL
Declare PtrSafe Function WriteTapemark Lib "kernel32" ( _
    ByVal hDevice As LongPtr, _
    ByVal dwTapemarkType As Long, _
    ByVal dwTapemarkCount 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

WriteTapemark = ctypes.windll.kernel32.WriteTapemark
WriteTapemark.restype = wintypes.DWORD
WriteTapemark.argtypes = [
    wintypes.HANDLE,  # hDevice : HANDLE
    wintypes.DWORD,  # dwTapemarkType : TAPEMARK_TYPE
    wintypes.DWORD,  # dwTapemarkCount : DWORD
    wintypes.BOOL,  # bImmediate : BOOL
]
require 'fiddle'
require 'fiddle/import'

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

var (
	kernel32 = windows.NewLazySystemDLL("KERNEL32.dll")
	procWriteTapemark = kernel32.NewProc("WriteTapemark")
)

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

extern "kernel32" fn WriteTapemark(
    hDevice: ?*anyopaque, // HANDLE
    dwTapemarkType: u32, // TAPEMARK_TYPE
    dwTapemarkCount: u32, // DWORD
    bImmediate: i32 // BOOL
) callconv(std.os.windows.WINAPI) u32;
proc WriteTapemark(
    hDevice: pointer,  # HANDLE
    dwTapemarkType: uint32,  # TAPEMARK_TYPE
    dwTapemarkCount: uint32,  # DWORD
    bImmediate: int32  # BOOL
): uint32 {.importc: "WriteTapemark", stdcall, dynlib: "KERNEL32.dll".}
pragma(lib, "kernel32");
extern(Windows)
uint WriteTapemark(
    void* hDevice,   // HANDLE
    uint dwTapemarkType,   // TAPEMARK_TYPE
    uint dwTapemarkCount,   // DWORD
    int bImmediate   // BOOL
);
ccall((:WriteTapemark, "KERNEL32.dll"), stdcall, UInt32,
      (Ptr{Cvoid}, UInt32, UInt32, Int32),
      hDevice, dwTapemarkType, dwTapemarkCount, bImmediate)
# hDevice : HANDLE -> Ptr{Cvoid}
# dwTapemarkType : TAPEMARK_TYPE -> UInt32
# dwTapemarkCount : DWORD -> UInt32
# bImmediate : BOOL -> Int32
# stdcall は 32bit のみ意味を持つ(x64 では無視)。
local ffi = require("ffi")
ffi.cdef[[
uint32_t WriteTapemark(
    void* hDevice,
    uint32_t dwTapemarkType,
    uint32_t dwTapemarkCount,
    int32_t bImmediate);
]]
local kernel32 = ffi.load("kernel32")
-- kernel32.WriteTapemark(hDevice, dwTapemarkType, dwTapemarkCount, bImmediate)
-- hDevice : HANDLE
-- dwTapemarkType : TAPEMARK_TYPE
-- dwTapemarkCount : DWORD
-- bImmediate : BOOL
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
const koffi = require('koffi');
const lib = koffi.load('KERNEL32.dll');
const WriteTapemark = lib.func('__stdcall', 'WriteTapemark', 'uint32_t', ['void *', 'uint32_t', 'uint32_t', 'int32_t']);
// WriteTapemark(hDevice, dwTapemarkType, dwTapemarkCount, bImmediate)
// hDevice : HANDLE -> 'void *'
// dwTapemarkType : TAPEMARK_TYPE -> 'uint32_t'
// dwTapemarkCount : DWORD -> 'uint32_t'
// bImmediate : BOOL -> 'int32_t'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。
const lib = Deno.dlopen("KERNEL32.dll", {
  WriteTapemark: { parameters: ["pointer", "u32", "u32", "i32"], result: "u32" },
});
// lib.symbols.WriteTapemark(hDevice, dwTapemarkType, dwTapemarkCount, bImmediate)
// hDevice : HANDLE -> "pointer"
// dwTapemarkType : TAPEMARK_TYPE -> "u32"
// dwTapemarkCount : DWORD -> "u32"
// bImmediate : BOOL -> "i32"
// 文字列引数は "buffer"(NUL 終端のバイト列を Uint8Array で渡す)。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。
<?php
$ffi = FFI::cdef(<<<C
uint32_t WriteTapemark(
    void* hDevice,
    uint32_t dwTapemarkType,
    uint32_t dwTapemarkCount,
    int32_t bImmediate);
C, "KERNEL32.dll");
// $ffi->WriteTapemark(hDevice, dwTapemarkType, dwTapemarkCount, bImmediate);
// hDevice : HANDLE
// dwTapemarkType : TAPEMARK_TYPE
// dwTapemarkCount : DWORD
// 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 WriteTapemark(
        Pointer hDevice,   // HANDLE
        int dwTapemarkType,   // TAPEMARK_TYPE
        int dwTapemarkCount,   // DWORD
        boolean bImmediate   // BOOL
    );
}
@[Link("kernel32")]
lib LibKERNEL32
  fun WriteTapemark = WriteTapemark(
    hDevice : Void*,   # HANDLE
    dwTapemarkType : UInt32,   # TAPEMARK_TYPE
    dwTapemarkCount : UInt32,   # DWORD
    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 WriteTapemarkNative = Uint32 Function(Pointer<Void>, Uint32, Uint32, Int32);
typedef WriteTapemarkDart = int Function(Pointer<Void>, int, int, int);
final WriteTapemark = DynamicLibrary.open('KERNEL32.dll')
    .lookupFunction<WriteTapemarkNative, WriteTapemarkDart>('WriteTapemark');
// hDevice : HANDLE -> Pointer<Void>
// dwTapemarkType : TAPEMARK_TYPE -> Uint32
// dwTapemarkCount : DWORD -> Uint32
// bImmediate : BOOL -> Int32
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function WriteTapemark(
  hDevice: THandle;   // HANDLE
  dwTapemarkType: DWORD;   // TAPEMARK_TYPE
  dwTapemarkCount: DWORD;   // DWORD
  bImmediate: BOOL   // BOOL
): DWORD; stdcall;
  external 'KERNEL32.dll' name 'WriteTapemark';
import Foreign
import Foreign.C.Types
import Foreign.C.String

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

let writetapemark =
  foreign "WriteTapemark"
    ((ptr void) @-> uint32_t @-> uint32_t @-> int32_t @-> returning uint32_t)
(* hDevice : HANDLE -> (ptr void) *)
(* dwTapemarkType : TAPEMARK_TYPE -> uint32_t *)
(* dwTapemarkCount : DWORD -> 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 ("WriteTapemark" write-tapemark :convention :stdcall) :uint32
  (h-device :pointer)   ; HANDLE
  (dw-tapemark-type :uint32)   ; TAPEMARK_TYPE
  (dw-tapemark-count :uint32)   ; DWORD
  (b-immediate :int32))   ; BOOL
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $WriteTapemark = Win32::API::More->new('KERNEL32',
    'DWORD WriteTapemark(HANDLE hDevice, DWORD dwTapemarkType, DWORD dwTapemarkCount, BOOL bImmediate)');
# my $ret = $WriteTapemark->Call($hDevice, $dwTapemarkType, $dwTapemarkCount, $bImmediate);
# hDevice : HANDLE -> HANDLE
# dwTapemarkType : TAPEMARK_TYPE -> DWORD
# dwTapemarkCount : DWORD -> DWORD
# bImmediate : BOOL -> BOOL
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。

関連項目

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