Win32 API 日本語リファレンス
ホームNetworking.ActiveDirectory › DsFreeSpnArrayW

DsFreeSpnArrayW

関数
DsGetSpnWで生成したSPN配列を解放する(Unicode版)。
DLLNTDSAPI.dll文字セットUnicode (-W)呼出規約winapi対応OSWindows Vista 以降

シグネチャ

// NTDSAPI.dll  (Unicode / -W)
#include <windows.h>

void DsFreeSpnArrayW(
    DWORD cSpn,
    LPWSTR* rpszSpn
);

パラメーター

名前方向説明
cSpnDWORDinrpszSpn配列のSPN個数。
rpszSpnLPWSTR*inoutDsGetSpnWが返したSPN文字列配列へのポインタ。これを解放する。

戻り値の型: void

各言語での呼び出し定義

// NTDSAPI.dll  (Unicode / -W)
#include <windows.h>

void DsFreeSpnArrayW(
    DWORD cSpn,
    LPWSTR* rpszSpn
);
[DllImport("NTDSAPI.dll", CharSet = CharSet.Unicode, ExactSpelling = true)]
static extern void DsFreeSpnArrayW(
    uint cSpn,   // DWORD
    IntPtr rpszSpn   // LPWSTR* in/out
);
<DllImport("NTDSAPI.dll", CharSet:=CharSet.Unicode, ExactSpelling:=True)>
Public Shared Sub DsFreeSpnArrayW(
    cSpn As UInteger,   ' DWORD
    rpszSpn As IntPtr   ' LPWSTR* in/out
)
End Sub
' cSpn : DWORD
' rpszSpn : LPWSTR* in/out
Declare PtrSafe Sub DsFreeSpnArrayW Lib "ntdsapi" ( _
    ByVal cSpn As Long, _
    ByVal rpszSpn As LongPtr)
' Unicode(W): 文字列は ByVal As LongPtr とし StrPtr(unicodeStr) を渡す
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。
import ctypes
from ctypes import wintypes

DsFreeSpnArrayW = ctypes.windll.ntdsapi.DsFreeSpnArrayW
DsFreeSpnArrayW.restype = None
DsFreeSpnArrayW.argtypes = [
    wintypes.DWORD,  # cSpn : DWORD
    ctypes.c_void_p,  # rpszSpn : LPWSTR* in/out
]
require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('NTDSAPI.dll')
DsFreeSpnArrayW = Fiddle::Function.new(
  lib['DsFreeSpnArrayW'],
  [
    -Fiddle::TYPE_INT,  # cSpn : DWORD
    Fiddle::TYPE_VOIDP,  # rpszSpn : LPWSTR* in/out
  ],
  Fiddle::TYPE_VOID)
# Wide strings: pass str.encode("UTF-16LE") + "\x00\x00"
#[link(name = "ntdsapi")]
extern "system" {
    fn DsFreeSpnArrayW(
        cSpn: u32,  // DWORD
        rpszSpn: *mut *mut u16  // LPWSTR* in/out
    );
}
// crates: windows-sys provides ready-made bindings for this API.
$sig = @"
[DllImport("NTDSAPI.dll", CharSet = CharSet.Unicode)]
public static extern void DsFreeSpnArrayW(uint cSpn, IntPtr rpszSpn);
"@
$api = Add-Type -MemberDefinition $sig -Name 'NTDSAPI_DsFreeSpnArrayW' -Namespace Win32 -PassThru
# $api::DsFreeSpnArrayW(cSpn, rpszSpn)
#uselib "NTDSAPI.dll"
#func global DsFreeSpnArrayW "DsFreeSpnArrayW" wptr, wptr
; DsFreeSpnArrayW cSpn, varptr(rpszSpn)
; cSpn : DWORD -> "wptr"
; rpszSpn : LPWSTR* in/out -> "wptr"
出力引数:
#uselib "NTDSAPI.dll"
#func global DsFreeSpnArrayW "DsFreeSpnArrayW" int, var
; DsFreeSpnArrayW cSpn, rpszSpn
; cSpn : DWORD -> "int"
; rpszSpn : LPWSTR* in/out -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
出力引数:
; void DsFreeSpnArrayW(DWORD cSpn, LPWSTR* rpszSpn)
#uselib "NTDSAPI.dll"
#func global DsFreeSpnArrayW "DsFreeSpnArrayW" int, var
; DsFreeSpnArrayW cSpn, rpszSpn
; cSpn : DWORD -> "int"
; rpszSpn : LPWSTR* in/out -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	ntdsapi = windows.NewLazySystemDLL("NTDSAPI.dll")
	procDsFreeSpnArrayW = ntdsapi.NewProc("DsFreeSpnArrayW")
)

// cSpn (DWORD), rpszSpn (LPWSTR* in/out)
r1, _, err := procDsFreeSpnArrayW.Call(
	uintptr(cSpn),
	uintptr(rpszSpn),
)
_ = err  // syscall.Errno (valid when the call sets last-error)
_ = r1   // void
procedure DsFreeSpnArrayW(
  cSpn: DWORD;   // DWORD
  rpszSpn: PPWideChar   // LPWSTR* in/out
); stdcall;
  external 'NTDSAPI.dll' name 'DsFreeSpnArrayW';
result := DllCall("NTDSAPI\DsFreeSpnArrayW"
    , "UInt", cSpn   ; DWORD
    , "Ptr", rpszSpn   ; LPWSTR* in/out
    , "Int")   ; return: void
●DsFreeSpnArrayW(cSpn, rpszSpn) = DLL("NTDSAPI.dll", "int DsFreeSpnArrayW(dword, void*)")
# 呼び出し: DsFreeSpnArrayW(cSpn, rpszSpn)
# cSpn : DWORD -> "dword"
# rpszSpn : LPWSTR* in/out -> "void*"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。
# ※-W(Unicode)関数。なでしこ1はANSIのため -A 版の利用を推奨。
const std = @import("std");

extern "ntdsapi" fn DsFreeSpnArrayW(
    cSpn: u32, // DWORD
    rpszSpn: [*c][*c]u16 // LPWSTR* in/out
) callconv(std.os.windows.WINAPI) void;
// Unicode(-W): UTF-16LE のヌル終端バッファ([*c]const u16)を渡す。
proc DsFreeSpnArrayW(
    cSpn: uint32,  # DWORD
    rpszSpn: ptr WideCString  # LPWSTR* in/out
) {.importc: "DsFreeSpnArrayW", stdcall, dynlib: "NTDSAPI.dll".}
# Unicode(-W): WideCString は newWideCString("...") で生成。
pragma(lib, "ntdsapi");
extern(Windows)
void DsFreeSpnArrayW(
    uint cSpn,   // DWORD
    wchar** rpszSpn   // LPWSTR* in/out
);
ccall((:DsFreeSpnArrayW, "NTDSAPI.dll"), stdcall, Cvoid,
      (UInt32, Ptr{Ptr{UInt16}}),
      cSpn, rpszSpn)
# cSpn : DWORD -> UInt32
# rpszSpn : LPWSTR* in/out -> Ptr{Ptr{UInt16}}
# stdcall は 32bit のみ意味を持つ(x64 では無視)。
# Unicode(-W): Cwstring には transcode(UInt16, "...") 等で UTF-16 を渡す。
local ffi = require("ffi")
ffi.cdef[[
void DsFreeSpnArrayW(
    uint32_t cSpn,
    uint16_t** rpszSpn);
]]
local ntdsapi = ffi.load("ntdsapi")
-- ntdsapi.DsFreeSpnArrayW(cSpn, rpszSpn)
-- cSpn : DWORD
-- rpszSpn : LPWSTR* in/out
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
-- Unicode(-W): uint16_t* には UTF-16LE のバッファ(ffi.new("uint16_t[?]", ...))を渡す。
const koffi = require('koffi');
const lib = koffi.load('NTDSAPI.dll');
const DsFreeSpnArrayW = lib.func('__stdcall', 'DsFreeSpnArrayW', 'void', ['uint32_t', 'void *']);
// DsFreeSpnArrayW(cSpn, rpszSpn)
// cSpn : DWORD -> 'uint32_t'
// rpszSpn : LPWSTR* in/out -> 'void *'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。
const lib = Deno.dlopen("NTDSAPI.dll", {
  DsFreeSpnArrayW: { parameters: ["u32", "pointer"], result: "void" },
});
// lib.symbols.DsFreeSpnArrayW(cSpn, rpszSpn)
// cSpn : DWORD -> "u32"
// rpszSpn : LPWSTR* in/out -> "pointer"
// 文字列は "buffer"。Unicode(-W) は new TextEncoder() ではなく UTF-16LE のバイト列(末尾に \x00\x00)を Uint8Array で渡す。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。
<?php
$ffi = FFI::cdef(<<<C
void DsFreeSpnArrayW(
    uint32_t cSpn,
    uint16_t** rpszSpn);
C, "NTDSAPI.dll");
// $ffi->DsFreeSpnArrayW(cSpn, rpszSpn);
// cSpn : DWORD
// rpszSpn : LPWSTR* in/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 Ntdsapi extends StdCallLibrary {
    Ntdsapi INSTANCE = Native.load("ntdsapi", Ntdsapi.class, W32APIOptions.UNICODE_OPTIONS);
    void DsFreeSpnArrayW(
        int cSpn,   // DWORD
        PointerByReference rpszSpn   // LPWSTR* in/out
    );
}
// Unicode(-W): WString(入力)/char[](出力)で UTF-16 をマーシャリング。
@[Link("ntdsapi")]
lib LibNTDSAPI
  fun DsFreeSpnArrayW = DsFreeSpnArrayW(
    cSpn : UInt32,   # DWORD
    rpszSpn : UInt16**   # LPWSTR* in/out
  ) : Void
end
# 構造体/GUID/enum は lib 内に対応する型定義が必要。
# 呼出規約: x64 は規約統一のため OK。x86(32bit)は WINAPI=stdcall だが Crystal の fun に stdcall 付与構文がなく非対応。
import 'dart:ffi';
import 'package:ffi/ffi.dart';

typedef DsFreeSpnArrayWNative = Void Function(Uint32, Pointer<Pointer<Utf16>>);
typedef DsFreeSpnArrayWDart = void Function(int, Pointer<Pointer<Utf16>>);
final DsFreeSpnArrayW = DynamicLibrary.open('NTDSAPI.dll')
    .lookupFunction<DsFreeSpnArrayWNative, DsFreeSpnArrayWDart>('DsFreeSpnArrayW');
// cSpn : DWORD -> Uint32
// rpszSpn : LPWSTR* in/out -> Pointer<Pointer<Utf16>>
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
procedure DsFreeSpnArrayW(
  cSpn: DWORD;   // DWORD
  rpszSpn: PPWideChar   // LPWSTR* in/out
); stdcall;
  external 'NTDSAPI.dll' name 'DsFreeSpnArrayW';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "DsFreeSpnArrayW"
  c_DsFreeSpnArrayW :: Word32 -> Ptr CWString -> IO ()
-- cSpn : DWORD -> Word32
-- rpszSpn : LPWSTR* in/out -> Ptr CWString
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let dsfreespnarrayw =
  foreign "DsFreeSpnArrayW"
    (uint32_t @-> (ptr (ptr uint16_t)) @-> returning void)
(* cSpn : DWORD -> uint32_t *)
(* rpszSpn : LPWSTR* in/out -> (ptr (ptr uint16_t)) *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)
(cffi:define-foreign-library ntdsapi (t "NTDSAPI.dll"))
(cffi:use-foreign-library ntdsapi)

(cffi:defcfun ("DsFreeSpnArrayW" ds-free-spn-array-w :convention :stdcall) :void
  (c-spn :uint32)   ; DWORD
  (rpsz-spn :pointer))   ; LPWSTR* in/out
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $DsFreeSpnArrayW = Win32::API::More->new('NTDSAPI',
    'void DsFreeSpnArrayW(DWORD cSpn, LPVOID rpszSpn)');
# my $ret = $DsFreeSpnArrayW->Call($cSpn, $rpszSpn);
# cSpn : DWORD -> DWORD
# rpszSpn : LPWSTR* in/out -> LPVOID
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。
# Unicode(-W): LPCWSTR/LPWSTR は Win32::API が UTF-16 変換を行う。

関連項目

文字セット違い