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

GetTapeStatus

関数
テープデバイスの現在の状態を取得する。
DLLKERNEL32.dll呼出規約winapi対応OSWindows XP 以降

シグネチャ

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

DWORD GetTapeStatus(
    HANDLE hDevice
);

パラメーター

名前方向説明
hDeviceHANDLEinデバイスの状態を取得する対象のデバイスへのハンドル。このハンドルは CreateFile 関数を使用して作成します。

戻り値の型: DWORD

公式ドキュメント

テープデバイスがテープコマンドを処理する準備ができているかどうかを判定します。

戻り値

テープデバイスが適切なテープアクセスコマンドをエラーを返さずに受け付ける準備ができている場合、戻り値は NO_ERROR です。

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

エラーコード 説明
ERROR_BEGINNING_OF_MEDIA
1102L
メディア先頭マーカーより前のデータにアクセスしようとして失敗しました。
ERROR_BUS_RESET
1111L
バス上でリセット状態が検出されました。
ERROR_DEVICE_NOT_PARTITIONED
1107L
テープのロード中にパーティション情報が見つかりませんでした。
ERROR_DEVICE_REQUIRES_CLEANING
1165L
テープドライブはクリーニングが必要であることを報告する機能を備えており、クリーニングが必要であると報告しています。
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
メディアは書き込み禁止になっています。
出典・ライセンス: 上記「公式ドキュメント」の内容は Microsoft の Win32 API ドキュメント(MicrosoftDocs/sdk-api)を日本語に翻訳・改変したものです。© Microsoft Corporation. CC BY 4.0 で提供。
Microsoft 公式リファレンス: 英語 (en-us) · 日本語 (ja-jp) · 原文ソース (GitHub)

各言語での呼び出し定義

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

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

GetTapeStatus = ctypes.windll.kernel32.GetTapeStatus
GetTapeStatus.restype = wintypes.DWORD
GetTapeStatus.argtypes = [
    wintypes.HANDLE,  # hDevice : HANDLE
]
require 'fiddle'
require 'fiddle/import'

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

var (
	kernel32 = windows.NewLazySystemDLL("KERNEL32.dll")
	procGetTapeStatus = kernel32.NewProc("GetTapeStatus")
)

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

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

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

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

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

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

関連項目

公式の関連項目