Win32 API 日本語リファレンス
ホームSystem.Console › SetConsoleCursorPosition

SetConsoleCursorPosition

関数
コンソール画面バッファ内のカーソル位置を設定する。
DLLKERNEL32.dll呼出規約winapiSetLastErrorあり

シグネチャ

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

BOOL SetConsoleCursorPosition(
    HANDLE hConsoleOutput,
    COORD dwCursorPosition
);

パラメーター

名前方向説明
hConsoleOutputHANDLEin対象のコンソール画面バッファのハンドル。
dwCursorPositionCOORDinカーソルを移動する位置の座標を示すCOORD値。

戻り値の型: BOOL

各言語での呼び出し定義

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

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

SetConsoleCursorPosition = ctypes.windll.kernel32.SetConsoleCursorPosition
SetConsoleCursorPosition.restype = wintypes.BOOL
SetConsoleCursorPosition.argtypes = [
    wintypes.HANDLE,  # hConsoleOutput : HANDLE
    COORD,  # dwCursorPosition : COORD
]
# GetLastError: use ctypes.GetLastError() (or ctypes.WinDLL(use_last_error=True))
require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('KERNEL32.dll')
SetConsoleCursorPosition = Fiddle::Function.new(
  lib['SetConsoleCursorPosition'],
  [
    Fiddle::TYPE_VOIDP,  # hConsoleOutput : HANDLE
    Fiddle::TYPE_VOIDP,  # dwCursorPosition : COORD
  ],
  Fiddle::TYPE_INT)
#[link(name = "kernel32")]
extern "system" {
    fn SetConsoleCursorPosition(
        hConsoleOutput: *mut core::ffi::c_void,  // HANDLE
        dwCursorPosition: COORD  // COORD
    ) -> i32;
}
// crates: windows-sys provides ready-made bindings for this API.
$sig = @"
[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("KERNEL32.dll", SetLastError = true)]
public static extern bool SetConsoleCursorPosition(IntPtr hConsoleOutput, COORD dwCursorPosition);
"@
$api = Add-Type -MemberDefinition $sig -Name 'KERNEL32_SetConsoleCursorPosition' -Namespace Win32 -PassThru
# $api::SetConsoleCursorPosition(hConsoleOutput, dwCursorPosition)
#uselib "KERNEL32.dll"
#func global SetConsoleCursorPosition "SetConsoleCursorPosition" sptr, sptr
; SetConsoleCursorPosition hConsoleOutput, dwCursorPosition   ; 戻り値は stat
; hConsoleOutput : HANDLE -> "sptr"
; dwCursorPosition : COORD -> "sptr"
; ※値渡し構造体は直接渡せません。intにパック、または var で構造体変数を渡してください。
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
#uselib "KERNEL32.dll"
#cfunc global SetConsoleCursorPosition "SetConsoleCursorPosition" sptr, int
; res = SetConsoleCursorPosition(hConsoleOutput, dwCursorPosition)
; hConsoleOutput : HANDLE -> "sptr"
; dwCursorPosition : COORD -> "int"
; ※値渡し構造体は直接渡せません。intにパック、または var で構造体変数を渡してください。
; BOOL SetConsoleCursorPosition(HANDLE hConsoleOutput, COORD dwCursorPosition)
#uselib "KERNEL32.dll"
#cfunc global SetConsoleCursorPosition "SetConsoleCursorPosition" intptr, int
; res = SetConsoleCursorPosition(hConsoleOutput, dwCursorPosition)
; hConsoleOutput : HANDLE -> "intptr"
; dwCursorPosition : COORD -> "int"
; ※値渡し構造体は直接渡せません。intにパック、または var で構造体変数を渡してください。
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	kernel32 = windows.NewLazySystemDLL("KERNEL32.dll")
	procSetConsoleCursorPosition = kernel32.NewProc("SetConsoleCursorPosition")
)

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

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

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

foreign import stdcall safe "SetConsoleCursorPosition"
  c_SetConsoleCursorPosition :: Ptr () -> COORD -> IO CInt
-- hConsoleOutput : HANDLE -> Ptr ()
-- dwCursorPosition : COORD -> COORD
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
-- ※値渡し構造体は GHC FFI で直接渡せません。Ptr で渡すラッパ(C側)経由にしてください。
open Ctypes
open Foreign

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

(cffi:defcfun ("SetConsoleCursorPosition" set-console-cursor-position :convention :stdcall) :int32
  (h-console-output :pointer)   ; HANDLE
  (dw-cursor-position (:struct coord)))   ; COORD
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $SetConsoleCursorPosition = Win32::API::More->new('KERNEL32',
    'BOOL SetConsoleCursorPosition(HANDLE hConsoleOutput, LPVOID dwCursorPosition)');
# my $ret = $SetConsoleCursorPosition->Call($hConsoleOutput, $dwCursorPosition);
# hConsoleOutput : HANDLE -> HANDLE
# dwCursorPosition : COORD -> LPVOID
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。

関連項目

使用する型