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

AreShortNamesEnabled

関数
ボリュームで短いファイル名生成が有効か判定する。
DLLKERNEL32.dll呼出規約winapi

シグネチャ

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

BOOL AreShortNamesEnabled(
    HANDLE Handle,
    BOOL* Enabled
);

パラメーター

名前方向説明
HandleHANDLEinクエリ対象のボリュームへのハンドル、またはそのボリューム上に存在するファイルもしくはディレクトリへのハンドル。
EnabledBOOL*outクエリ結果を受け取る BOOLEAN 値へのポインター。TRUE の場合、そのボリュームで短い名前が有効になっています。それ以外の場合は FALSE が返されます。

戻り値の型: BOOL

公式ドキュメント

AreShortNamesEnabled 関数は、指定されたボリュームで短い名前(ショートネーム)が有効になっているかどうかを判定します。

戻り値

関数が成功したかどうかを示す BOOLEAN 値。関数が成功した場合、戻り値は TRUE です。関数が失敗した場合、戻り値は FALSE です。拡張エラー情報を取得するには、GetLastError 関数を呼び出します。

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

各言語での呼び出し定義

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

BOOL AreShortNamesEnabled(
    HANDLE Handle,
    BOOL* Enabled
);
[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("KERNEL32.dll", ExactSpelling = true)]
static extern bool AreShortNamesEnabled(
    IntPtr Handle,   // HANDLE
    out bool Enabled   // BOOL* out
);
<DllImport("KERNEL32.dll", ExactSpelling:=True)>
Public Shared Function AreShortNamesEnabled(
    Handle As IntPtr,   ' HANDLE
    <Out> ByRef Enabled As Boolean   ' BOOL* out
) As <MarshalAs(UnmanagedType.Bool)> Boolean
End Function
' Handle : HANDLE
' Enabled : BOOL* out
Declare PtrSafe Function AreShortNamesEnabled Lib "kernel32" ( _
    ByVal Handle As LongPtr, _
    ByRef Enabled As Long) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。
import ctypes
from ctypes import wintypes

AreShortNamesEnabled = ctypes.windll.kernel32.AreShortNamesEnabled
AreShortNamesEnabled.restype = wintypes.BOOL
AreShortNamesEnabled.argtypes = [
    wintypes.HANDLE,  # Handle : HANDLE
    ctypes.c_void_p,  # Enabled : BOOL* out
]
require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('KERNEL32.dll')
AreShortNamesEnabled = Fiddle::Function.new(
  lib['AreShortNamesEnabled'],
  [
    Fiddle::TYPE_VOIDP,  # Handle : HANDLE
    Fiddle::TYPE_VOIDP,  # Enabled : BOOL* out
  ],
  Fiddle::TYPE_INT)
#[link(name = "kernel32")]
extern "system" {
    fn AreShortNamesEnabled(
        Handle: *mut core::ffi::c_void,  // HANDLE
        Enabled: *mut i32  // BOOL* out
    ) -> i32;
}
// crates: windows-sys provides ready-made bindings for this API.
$sig = @"
[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("KERNEL32.dll")]
public static extern bool AreShortNamesEnabled(IntPtr Handle, out bool Enabled);
"@
$api = Add-Type -MemberDefinition $sig -Name 'KERNEL32_AreShortNamesEnabled' -Namespace Win32 -PassThru
# $api::AreShortNamesEnabled(Handle, Enabled)
#uselib "KERNEL32.dll"
#func global AreShortNamesEnabled "AreShortNamesEnabled" sptr, sptr
; AreShortNamesEnabled Handle, varptr(Enabled)   ; 戻り値は stat
; Handle : HANDLE -> "sptr"
; Enabled : BOOL* out -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
出力引数:
#uselib "KERNEL32.dll"
#cfunc global AreShortNamesEnabled "AreShortNamesEnabled" sptr, var
; res = AreShortNamesEnabled(Handle, Enabled)
; Handle : HANDLE -> "sptr"
; Enabled : BOOL* out -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
出力引数:
; BOOL AreShortNamesEnabled(HANDLE Handle, BOOL* Enabled)
#uselib "KERNEL32.dll"
#cfunc global AreShortNamesEnabled "AreShortNamesEnabled" intptr, var
; res = AreShortNamesEnabled(Handle, Enabled)
; Handle : HANDLE -> "intptr"
; Enabled : BOOL* out -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	kernel32 = windows.NewLazySystemDLL("KERNEL32.dll")
	procAreShortNamesEnabled = kernel32.NewProc("AreShortNamesEnabled")
)

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

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

typedef AreShortNamesEnabledNative = Int32 Function(Pointer<Void>, Pointer<Int32>);
typedef AreShortNamesEnabledDart = int Function(Pointer<Void>, Pointer<Int32>);
final AreShortNamesEnabled = DynamicLibrary.open('KERNEL32.dll')
    .lookupFunction<AreShortNamesEnabledNative, AreShortNamesEnabledDart>('AreShortNamesEnabled');
// Handle : HANDLE -> Pointer<Void>
// Enabled : BOOL* out -> Pointer<Int32>
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function AreShortNamesEnabled(
  Handle: THandle;   // HANDLE
  Enabled: Pointer   // BOOL* out
): BOOL; stdcall;
  external 'KERNEL32.dll' name 'AreShortNamesEnabled';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "AreShortNamesEnabled"
  c_AreShortNamesEnabled :: Ptr () -> Ptr CInt -> IO CInt
-- Handle : HANDLE -> Ptr ()
-- Enabled : BOOL* out -> Ptr CInt
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

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

(cffi:defcfun ("AreShortNamesEnabled" are-short-names-enabled :convention :stdcall) :int32
  (handle :pointer)   ; HANDLE
  (enabled :pointer))   ; BOOL* out
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $AreShortNamesEnabled = Win32::API::More->new('KERNEL32',
    'BOOL AreShortNamesEnabled(HANDLE Handle, LPVOID Enabled)');
# my $ret = $AreShortNamesEnabled->Call($Handle, $Enabled);
# Handle : HANDLE -> HANDLE
# Enabled : BOOL* out -> LPVOID
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。