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

GetActiveProcessorCount

関数
指定グループまたは全体のアクティブなプロセッサ数を取得する。
DLLKERNEL32.dll呼出規約winapiSetLastErrorあり対応OSWindows 7 以降

シグネチャ

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

DWORD GetActiveProcessorCount(
    WORD GroupNumber
);

パラメーター

名前方向説明
GroupNumberWORDinプロセッサグループ番号。このパラメーターが ALL_PROCESSOR_GROUPS の場合、関数はシステム内のアクティブなプロセッサ数を返します。

戻り値の型: DWORD

公式ドキュメント

プロセッサグループ内またはシステム内のアクティブなプロセッサ数を返します。

戻り値

関数が成功すると、戻り値は指定したグループ内のアクティブなプロセッサ数です。

関数が失敗すると、戻り値は 0 です。拡張エラー情報を取得するには、GetLastError を使用します。

解説(Remarks)

この関数を使用するアプリケーションをコンパイルするには、_WIN32_WINNT >= 0x0601 を設定します。詳細については、Using the Windows Headers を参照してください。

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

各言語での呼び出し定義

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

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

GetActiveProcessorCount = ctypes.windll.kernel32.GetActiveProcessorCount
GetActiveProcessorCount.restype = wintypes.DWORD
GetActiveProcessorCount.argtypes = [
    ctypes.c_ushort,  # GroupNumber : WORD
]
# GetLastError: use ctypes.GetLastError() (or ctypes.WinDLL(use_last_error=True))
require 'fiddle'
require 'fiddle/import'

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

var (
	kernel32 = windows.NewLazySystemDLL("KERNEL32.dll")
	procGetActiveProcessorCount = kernel32.NewProc("GetActiveProcessorCount")
)

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

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

typedef GetActiveProcessorCountNative = Uint32 Function(Uint16);
typedef GetActiveProcessorCountDart = int Function(int);
final GetActiveProcessorCount = DynamicLibrary.open('KERNEL32.dll')
    .lookupFunction<GetActiveProcessorCountNative, GetActiveProcessorCountDart>('GetActiveProcessorCount');
// GroupNumber : WORD -> Uint16
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function GetActiveProcessorCount(
  GroupNumber: Word   // WORD
): DWORD; stdcall;
  external 'KERNEL32.dll' name 'GetActiveProcessorCount';
import Foreign
import Foreign.C.Types
import Foreign.C.String

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

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

(cffi:defcfun ("GetActiveProcessorCount" get-active-processor-count :convention :stdcall) :uint32
  (group-number :uint16))   ; WORD
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $GetActiveProcessorCount = Win32::API::More->new('KERNEL32',
    'DWORD GetActiveProcessorCount(WORD GroupNumber)');
# my $ret = $GetActiveProcessorCount->Call($GroupNumber);
# GroupNumber : WORD -> WORD
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。