Win32 API 日本語リファレンス
ホームSecurity › GetSidLengthRequired

GetSidLengthRequired

関数
指定サブ権限数のSIDに必要なバイト長を取得する。
DLLADVAPI32.dll呼出規約winapi対応OSWindows XP 以降

シグネチャ

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

DWORD GetSidLengthRequired(
    BYTE nSubAuthorityCount
);

パラメーター

名前方向説明
nSubAuthorityCountBYTEinSID 構造体に格納するサブオーソリティの数を指定します。

戻り値の型: DWORD

公式ドキュメント

指定された数のサブオーソリティを持つ SID を格納するために必要なバッファの長さをバイト単位で返します。

戻り値

戻り値は、SID 構造体を格納するために必要なバッファの長さ (バイト単位) です。この関数は失敗しません。

解説(Remarks)

nSubAuthorityCount で指定される SID 構造体は、32 ビットの RID 値を使用します。より長い RID 値を必要とするアプリケーションでは、 CreateWellKnownSid および関連する関数を使用してください。

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

各言語での呼び出し定義

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

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

GetSidLengthRequired = ctypes.windll.advapi32.GetSidLengthRequired
GetSidLengthRequired.restype = wintypes.DWORD
GetSidLengthRequired.argtypes = [
    ctypes.c_ubyte,  # nSubAuthorityCount : BYTE
]
require 'fiddle'
require 'fiddle/import'

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

var (
	advapi32 = windows.NewLazySystemDLL("ADVAPI32.dll")
	procGetSidLengthRequired = advapi32.NewProc("GetSidLengthRequired")
)

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

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

typedef GetSidLengthRequiredNative = Uint32 Function(Uint8);
typedef GetSidLengthRequiredDart = int Function(int);
final GetSidLengthRequired = DynamicLibrary.open('ADVAPI32.dll')
    .lookupFunction<GetSidLengthRequiredNative, GetSidLengthRequiredDart>('GetSidLengthRequired');
// nSubAuthorityCount : BYTE -> Uint8
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function GetSidLengthRequired(
  nSubAuthorityCount: Byte   // BYTE
): DWORD; stdcall;
  external 'ADVAPI32.dll' name 'GetSidLengthRequired';
import Foreign
import Foreign.C.Types
import Foreign.C.String

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

let getsidlengthrequired =
  foreign "GetSidLengthRequired"
    (uint8_t @-> returning uint32_t)
(* nSubAuthorityCount : BYTE -> uint8_t *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)
(cffi:define-foreign-library advapi32 (t "ADVAPI32.dll"))
(cffi:use-foreign-library advapi32)

(cffi:defcfun ("GetSidLengthRequired" get-sid-length-required :convention :stdcall) :uint32
  (n-sub-authority-count :uint8))   ; BYTE
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $GetSidLengthRequired = Win32::API::More->new('ADVAPI32',
    'DWORD GetSidLengthRequired(BYTE nSubAuthorityCount)');
# my $ret = $GetSidLengthRequired->Call($nSubAuthorityCount);
# nSubAuthorityCount : BYTE -> BYTE
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。

関連項目

公式の関連項目