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

DsCrackNamesA

関数
オブジェクト名を指定形式間で変換する(ANSI版)。
DLLNTDSAPI.dll文字セットANSI (-A)呼出規約winapi対応OSWindows Vista 以降

シグネチャ

// NTDSAPI.dll  (ANSI / -A)
#include <windows.h>

DWORD DsCrackNamesA(
    HANDLE hDS,   // optional
    DS_NAME_FLAGS flags,
    DS_NAME_FORMAT formatOffered,
    DS_NAME_FORMAT formatDesired,
    DWORD cNames,
    LPCSTR* rpNames,
    DS_NAME_RESULTA** ppResult
);

パラメーター

名前方向説明
hDSHANDLEinoptional名前変換に用いるディレクトリサービスバインドハンドル。
flagsDS_NAME_FLAGSin変換動作を制御するDS_NAME_FLAGSフラグ。
formatOfferedDS_NAME_FORMATin入力名のフォーマットを示すDS_NAME_FORMAT列挙値。
formatDesiredDS_NAME_FORMATin出力に望むフォーマットを示すDS_NAME_FORMAT列挙値。
cNamesDWORDin変換する名前の個数。
rpNamesLPCSTR*in変換元の名前文字列(ANSI)の配列へのポインタ。
ppResultDS_NAME_RESULTA**out変換結果のDS_NAME_RESULTAを受け取るポインタのアドレス。DsFreeNameResultAで解放する。

戻り値の型: DWORD

各言語での呼び出し定義

// NTDSAPI.dll  (ANSI / -A)
#include <windows.h>

DWORD DsCrackNamesA(
    HANDLE hDS,   // optional
    DS_NAME_FLAGS flags,
    DS_NAME_FORMAT formatOffered,
    DS_NAME_FORMAT formatDesired,
    DWORD cNames,
    LPCSTR* rpNames,
    DS_NAME_RESULTA** ppResult
);
[DllImport("NTDSAPI.dll", CharSet = CharSet.Ansi, ExactSpelling = true)]
static extern uint DsCrackNamesA(
    IntPtr hDS,   // HANDLE optional
    int flags,   // DS_NAME_FLAGS
    int formatOffered,   // DS_NAME_FORMAT
    int formatDesired,   // DS_NAME_FORMAT
    uint cNames,   // DWORD
    IntPtr rpNames,   // LPCSTR*
    IntPtr ppResult   // DS_NAME_RESULTA** out
);
<DllImport("NTDSAPI.dll", CharSet:=CharSet.Ansi, ExactSpelling:=True)>
Public Shared Function DsCrackNamesA(
    hDS As IntPtr,   ' HANDLE optional
    flags As Integer,   ' DS_NAME_FLAGS
    formatOffered As Integer,   ' DS_NAME_FORMAT
    formatDesired As Integer,   ' DS_NAME_FORMAT
    cNames As UInteger,   ' DWORD
    rpNames As IntPtr,   ' LPCSTR*
    ppResult As IntPtr   ' DS_NAME_RESULTA** out
) As UInteger
End Function
' hDS : HANDLE optional
' flags : DS_NAME_FLAGS
' formatOffered : DS_NAME_FORMAT
' formatDesired : DS_NAME_FORMAT
' cNames : DWORD
' rpNames : LPCSTR*
' ppResult : DS_NAME_RESULTA** out
Declare PtrSafe Function DsCrackNamesA Lib "ntdsapi" ( _
    ByVal hDS As LongPtr, _
    ByVal flags As Long, _
    ByVal formatOffered As Long, _
    ByVal formatDesired As Long, _
    ByVal cNames As Long, _
    ByVal rpNames As LongPtr, _
    ByVal ppResult As LongPtr) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。
import ctypes
from ctypes import wintypes

DsCrackNamesA = ctypes.windll.ntdsapi.DsCrackNamesA
DsCrackNamesA.restype = wintypes.DWORD
DsCrackNamesA.argtypes = [
    wintypes.HANDLE,  # hDS : HANDLE optional
    ctypes.c_int,  # flags : DS_NAME_FLAGS
    ctypes.c_int,  # formatOffered : DS_NAME_FORMAT
    ctypes.c_int,  # formatDesired : DS_NAME_FORMAT
    wintypes.DWORD,  # cNames : DWORD
    ctypes.c_void_p,  # rpNames : LPCSTR*
    ctypes.c_void_p,  # ppResult : DS_NAME_RESULTA** out
]
require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('NTDSAPI.dll')
DsCrackNamesA = Fiddle::Function.new(
  lib['DsCrackNamesA'],
  [
    Fiddle::TYPE_VOIDP,  # hDS : HANDLE optional
    Fiddle::TYPE_INT,  # flags : DS_NAME_FLAGS
    Fiddle::TYPE_INT,  # formatOffered : DS_NAME_FORMAT
    Fiddle::TYPE_INT,  # formatDesired : DS_NAME_FORMAT
    -Fiddle::TYPE_INT,  # cNames : DWORD
    Fiddle::TYPE_VOIDP,  # rpNames : LPCSTR*
    Fiddle::TYPE_VOIDP,  # ppResult : DS_NAME_RESULTA** out
  ],
  -Fiddle::TYPE_INT)
#[link(name = "ntdsapi")]
extern "system" {
    fn DsCrackNamesA(
        hDS: *mut core::ffi::c_void,  // HANDLE optional
        flags: i32,  // DS_NAME_FLAGS
        formatOffered: i32,  // DS_NAME_FORMAT
        formatDesired: i32,  // DS_NAME_FORMAT
        cNames: u32,  // DWORD
        rpNames: *const *const u8,  // LPCSTR*
        ppResult: *mut *mut DS_NAME_RESULTA  // DS_NAME_RESULTA** out
    ) -> u32;
}
// crates: windows-sys provides ready-made bindings for this API.
$sig = @"
[DllImport("NTDSAPI.dll", CharSet = CharSet.Ansi)]
public static extern uint DsCrackNamesA(IntPtr hDS, int flags, int formatOffered, int formatDesired, uint cNames, IntPtr rpNames, IntPtr ppResult);
"@
$api = Add-Type -MemberDefinition $sig -Name 'NTDSAPI_DsCrackNamesA' -Namespace Win32 -PassThru
# $api::DsCrackNamesA(hDS, flags, formatOffered, formatDesired, cNames, rpNames, ppResult)
#uselib "NTDSAPI.dll"
#func global DsCrackNamesA "DsCrackNamesA" sptr, sptr, sptr, sptr, sptr, sptr, sptr
; DsCrackNamesA hDS, flags, formatOffered, formatDesired, cNames, varptr(rpNames), varptr(ppResult)   ; 戻り値は stat
; hDS : HANDLE optional -> "sptr"
; flags : DS_NAME_FLAGS -> "sptr"
; formatOffered : DS_NAME_FORMAT -> "sptr"
; formatDesired : DS_NAME_FORMAT -> "sptr"
; cNames : DWORD -> "sptr"
; rpNames : LPCSTR* -> "sptr"
; ppResult : DS_NAME_RESULTA** out -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
出力引数:
#uselib "NTDSAPI.dll"
#cfunc global DsCrackNamesA "DsCrackNamesA" sptr, int, int, int, int, var, var
; res = DsCrackNamesA(hDS, flags, formatOffered, formatDesired, cNames, rpNames, ppResult)
; hDS : HANDLE optional -> "sptr"
; flags : DS_NAME_FLAGS -> "int"
; formatOffered : DS_NAME_FORMAT -> "int"
; formatDesired : DS_NAME_FORMAT -> "int"
; cNames : DWORD -> "int"
; rpNames : LPCSTR* -> "var"
; ppResult : DS_NAME_RESULTA** out -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
出力引数:
; DWORD DsCrackNamesA(HANDLE hDS, DS_NAME_FLAGS flags, DS_NAME_FORMAT formatOffered, DS_NAME_FORMAT formatDesired, DWORD cNames, LPCSTR* rpNames, DS_NAME_RESULTA** ppResult)
#uselib "NTDSAPI.dll"
#cfunc global DsCrackNamesA "DsCrackNamesA" intptr, int, int, int, int, var, var
; res = DsCrackNamesA(hDS, flags, formatOffered, formatDesired, cNames, rpNames, ppResult)
; hDS : HANDLE optional -> "intptr"
; flags : DS_NAME_FLAGS -> "int"
; formatOffered : DS_NAME_FORMAT -> "int"
; formatDesired : DS_NAME_FORMAT -> "int"
; cNames : DWORD -> "int"
; rpNames : LPCSTR* -> "var"
; ppResult : DS_NAME_RESULTA** out -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	ntdsapi = windows.NewLazySystemDLL("NTDSAPI.dll")
	procDsCrackNamesA = ntdsapi.NewProc("DsCrackNamesA")
)

// hDS (HANDLE optional), flags (DS_NAME_FLAGS), formatOffered (DS_NAME_FORMAT), formatDesired (DS_NAME_FORMAT), cNames (DWORD), rpNames (LPCSTR*), ppResult (DS_NAME_RESULTA** out)
r1, _, err := procDsCrackNamesA.Call(
	uintptr(hDS),
	uintptr(flags),
	uintptr(formatOffered),
	uintptr(formatDesired),
	uintptr(cNames),
	uintptr(rpNames),
	uintptr(ppResult),
)
_ = err  // syscall.Errno (valid when the call sets last-error)
_ = r1   // DWORD
function DsCrackNamesA(
  hDS: THandle;   // HANDLE optional
  flags: Integer;   // DS_NAME_FLAGS
  formatOffered: Integer;   // DS_NAME_FORMAT
  formatDesired: Integer;   // DS_NAME_FORMAT
  cNames: DWORD;   // DWORD
  rpNames: PPAnsiChar;   // LPCSTR*
  ppResult: Pointer   // DS_NAME_RESULTA** out
): DWORD; stdcall;
  external 'NTDSAPI.dll' name 'DsCrackNamesA';
result := DllCall("NTDSAPI\DsCrackNamesA"
    , "Ptr", hDS   ; HANDLE optional
    , "Int", flags   ; DS_NAME_FLAGS
    , "Int", formatOffered   ; DS_NAME_FORMAT
    , "Int", formatDesired   ; DS_NAME_FORMAT
    , "UInt", cNames   ; DWORD
    , "Ptr", rpNames   ; LPCSTR*
    , "Ptr", ppResult   ; DS_NAME_RESULTA** out
    , "UInt")   ; return: DWORD
●DsCrackNamesA(hDS, flags, formatOffered, formatDesired, cNames, rpNames, ppResult) = DLL("NTDSAPI.dll", "dword DsCrackNamesA(void*, int, int, int, dword, void*, void*)")
# 呼び出し: DsCrackNamesA(hDS, flags, formatOffered, formatDesired, cNames, rpNames, ppResult)
# hDS : HANDLE optional -> "void*"
# flags : DS_NAME_FLAGS -> "int"
# formatOffered : DS_NAME_FORMAT -> "int"
# formatDesired : DS_NAME_FORMAT -> "int"
# cNames : DWORD -> "dword"
# rpNames : LPCSTR* -> "void*"
# ppResult : DS_NAME_RESULTA** out -> "void*"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。
const std = @import("std");

extern "ntdsapi" fn DsCrackNamesA(
    hDS: ?*anyopaque, // HANDLE optional
    flags: i32, // DS_NAME_FLAGS
    formatOffered: i32, // DS_NAME_FORMAT
    formatDesired: i32, // DS_NAME_FORMAT
    cNames: u32, // DWORD
    rpNames: [*c][*c]u8, // LPCSTR*
    ppResult: [*c][*c]DS_NAME_RESULTA // DS_NAME_RESULTA** out
) callconv(std.os.windows.WINAPI) u32;
proc DsCrackNamesA(
    hDS: pointer,  # HANDLE optional
    flags: int32,  # DS_NAME_FLAGS
    formatOffered: int32,  # DS_NAME_FORMAT
    formatDesired: int32,  # DS_NAME_FORMAT
    cNames: uint32,  # DWORD
    rpNames: ptr cstring,  # LPCSTR*
    ppResult: ptr DS_NAME_RESULTA  # DS_NAME_RESULTA** out
): uint32 {.importc: "DsCrackNamesA", stdcall, dynlib: "NTDSAPI.dll".}
pragma(lib, "ntdsapi");
extern(Windows)
uint DsCrackNamesA(
    void* hDS,   // HANDLE optional
    int flags,   // DS_NAME_FLAGS
    int formatOffered,   // DS_NAME_FORMAT
    int formatDesired,   // DS_NAME_FORMAT
    uint cNames,   // DWORD
    char** rpNames,   // LPCSTR*
    DS_NAME_RESULTA** ppResult   // DS_NAME_RESULTA** out
);
ccall((:DsCrackNamesA, "NTDSAPI.dll"), stdcall, UInt32,
      (Ptr{Cvoid}, Int32, Int32, Int32, UInt32, Ptr{Ptr{UInt8}}, Ptr{DS_NAME_RESULTA}),
      hDS, flags, formatOffered, formatDesired, cNames, rpNames, ppResult)
# hDS : HANDLE optional -> Ptr{Cvoid}
# flags : DS_NAME_FLAGS -> Int32
# formatOffered : DS_NAME_FORMAT -> Int32
# formatDesired : DS_NAME_FORMAT -> Int32
# cNames : DWORD -> UInt32
# rpNames : LPCSTR* -> Ptr{Ptr{UInt8}}
# ppResult : DS_NAME_RESULTA** out -> Ptr{DS_NAME_RESULTA}
# stdcall は 32bit のみ意味を持つ(x64 では無視)。
local ffi = require("ffi")
ffi.cdef[[
uint32_t DsCrackNamesA(
    void* hDS,
    int32_t flags,
    int32_t formatOffered,
    int32_t formatDesired,
    uint32_t cNames,
    char** rpNames,
    void* ppResult);
]]
local ntdsapi = ffi.load("ntdsapi")
-- ntdsapi.DsCrackNamesA(hDS, flags, formatOffered, formatDesired, cNames, rpNames, ppResult)
-- hDS : HANDLE optional
-- flags : DS_NAME_FLAGS
-- formatOffered : DS_NAME_FORMAT
-- formatDesired : DS_NAME_FORMAT
-- cNames : DWORD
-- rpNames : LPCSTR*
-- ppResult : DS_NAME_RESULTA** out
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
const koffi = require('koffi');
const lib = koffi.load('NTDSAPI.dll');
const DsCrackNamesA = lib.func('__stdcall', 'DsCrackNamesA', 'uint32_t', ['void *', 'int32_t', 'int32_t', 'int32_t', 'uint32_t', 'void *', 'void *']);
// DsCrackNamesA(hDS, flags, formatOffered, formatDesired, cNames, rpNames, ppResult)
// hDS : HANDLE optional -> 'void *'
// flags : DS_NAME_FLAGS -> 'int32_t'
// formatOffered : DS_NAME_FORMAT -> 'int32_t'
// formatDesired : DS_NAME_FORMAT -> 'int32_t'
// cNames : DWORD -> 'uint32_t'
// rpNames : LPCSTR* -> 'void *'
// ppResult : DS_NAME_RESULTA** out -> 'void *'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。
const lib = Deno.dlopen("NTDSAPI.dll", {
  DsCrackNamesA: { parameters: ["pointer", "i32", "i32", "i32", "u32", "pointer", "pointer"], result: "u32" },
});
// lib.symbols.DsCrackNamesA(hDS, flags, formatOffered, formatDesired, cNames, rpNames, ppResult)
// hDS : HANDLE optional -> "pointer"
// flags : DS_NAME_FLAGS -> "i32"
// formatOffered : DS_NAME_FORMAT -> "i32"
// formatDesired : DS_NAME_FORMAT -> "i32"
// cNames : DWORD -> "u32"
// rpNames : LPCSTR* -> "pointer"
// ppResult : DS_NAME_RESULTA** out -> "pointer"
// 文字列は "buffer"。ANSI(-A) は new TextEncoder() で UTF-8/ANSI バイト列(末尾に \x00)を渡す。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。
<?php
$ffi = FFI::cdef(<<<C
uint32_t DsCrackNamesA(
    void* hDS,
    int32_t flags,
    int32_t formatOffered,
    int32_t formatDesired,
    uint32_t cNames,
    char** rpNames,
    void* ppResult);
C, "NTDSAPI.dll");
// $ffi->DsCrackNamesA(hDS, flags, formatOffered, formatDesired, cNames, rpNames, ppResult);
// hDS : HANDLE optional
// flags : DS_NAME_FLAGS
// formatOffered : DS_NAME_FORMAT
// formatDesired : DS_NAME_FORMAT
// cNames : DWORD
// rpNames : LPCSTR*
// ppResult : DS_NAME_RESULTA** 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.ASCII_OPTIONS);
    int DsCrackNamesA(
        Pointer hDS,   // HANDLE optional
        int flags,   // DS_NAME_FLAGS
        int formatOffered,   // DS_NAME_FORMAT
        int formatDesired,   // DS_NAME_FORMAT
        int cNames,   // DWORD
        PointerByReference rpNames,   // LPCSTR*
        Pointer ppResult   // DS_NAME_RESULTA** out
    );
}
@[Link("ntdsapi")]
lib LibNTDSAPI
  fun DsCrackNamesA = DsCrackNamesA(
    hDS : Void*,   # HANDLE optional
    flags : Int32,   # DS_NAME_FLAGS
    formatOffered : Int32,   # DS_NAME_FORMAT
    formatDesired : Int32,   # DS_NAME_FORMAT
    cNames : UInt32,   # DWORD
    rpNames : UInt8**,   # LPCSTR*
    ppResult : DS_NAME_RESULTA**   # DS_NAME_RESULTA** out
  ) : UInt32
end
# 構造体/GUID/enum は lib 内に対応する型定義が必要。
# 呼出規約: x64 は規約統一のため OK。x86(32bit)は WINAPI=stdcall だが Crystal の fun に stdcall 付与構文がなく非対応。
import 'dart:ffi';
import 'package:ffi/ffi.dart';

typedef DsCrackNamesANative = Uint32 Function(Pointer<Void>, Int32, Int32, Int32, Uint32, Pointer<Pointer<Utf8>>, Pointer<Void>);
typedef DsCrackNamesADart = int Function(Pointer<Void>, int, int, int, int, Pointer<Pointer<Utf8>>, Pointer<Void>);
final DsCrackNamesA = DynamicLibrary.open('NTDSAPI.dll')
    .lookupFunction<DsCrackNamesANative, DsCrackNamesADart>('DsCrackNamesA');
// hDS : HANDLE optional -> Pointer<Void>
// flags : DS_NAME_FLAGS -> Int32
// formatOffered : DS_NAME_FORMAT -> Int32
// formatDesired : DS_NAME_FORMAT -> Int32
// cNames : DWORD -> Uint32
// rpNames : LPCSTR* -> Pointer<Pointer<Utf8>>
// ppResult : DS_NAME_RESULTA** out -> Pointer<Void>
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function DsCrackNamesA(
  hDS: THandle;   // HANDLE optional
  flags: Integer;   // DS_NAME_FLAGS
  formatOffered: Integer;   // DS_NAME_FORMAT
  formatDesired: Integer;   // DS_NAME_FORMAT
  cNames: DWORD;   // DWORD
  rpNames: PPAnsiChar;   // LPCSTR*
  ppResult: Pointer   // DS_NAME_RESULTA** out
): DWORD; stdcall;
  external 'NTDSAPI.dll' name 'DsCrackNamesA';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "DsCrackNamesA"
  c_DsCrackNamesA :: Ptr () -> Int32 -> Int32 -> Int32 -> Word32 -> Ptr CString -> Ptr () -> IO Word32
-- hDS : HANDLE optional -> Ptr ()
-- flags : DS_NAME_FLAGS -> Int32
-- formatOffered : DS_NAME_FORMAT -> Int32
-- formatDesired : DS_NAME_FORMAT -> Int32
-- cNames : DWORD -> Word32
-- rpNames : LPCSTR* -> Ptr CString
-- ppResult : DS_NAME_RESULTA** out -> Ptr ()
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let dscracknamesa =
  foreign "DsCrackNamesA"
    ((ptr void) @-> int32_t @-> int32_t @-> int32_t @-> uint32_t @-> (ptr string) @-> (ptr void) @-> returning uint32_t)
(* hDS : HANDLE optional -> (ptr void) *)
(* flags : DS_NAME_FLAGS -> int32_t *)
(* formatOffered : DS_NAME_FORMAT -> int32_t *)
(* formatDesired : DS_NAME_FORMAT -> int32_t *)
(* cNames : DWORD -> uint32_t *)
(* rpNames : LPCSTR* -> (ptr string) *)
(* ppResult : DS_NAME_RESULTA** out -> (ptr void) *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)
(cffi:define-foreign-library ntdsapi (t "NTDSAPI.dll"))
(cffi:use-foreign-library ntdsapi)

(cffi:defcfun ("DsCrackNamesA" ds-crack-names-a :convention :stdcall) :uint32
  (h-ds :pointer)   ; HANDLE optional
  (flags :int32)   ; DS_NAME_FLAGS
  (format-offered :int32)   ; DS_NAME_FORMAT
  (format-desired :int32)   ; DS_NAME_FORMAT
  (c-names :uint32)   ; DWORD
  (rp-names :pointer)   ; LPCSTR*
  (pp-result :pointer))   ; DS_NAME_RESULTA** out
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $DsCrackNamesA = Win32::API::More->new('NTDSAPI',
    'DWORD DsCrackNamesA(HANDLE hDS, int flags, int formatOffered, int formatDesired, DWORD cNames, LPVOID rpNames, LPVOID ppResult)');
# my $ret = $DsCrackNamesA->Call($hDS, $flags, $formatOffered, $formatDesired, $cNames, $rpNames, $ppResult);
# hDS : HANDLE optional -> HANDLE
# flags : DS_NAME_FLAGS -> int
# formatOffered : DS_NAME_FORMAT -> int
# formatDesired : DS_NAME_FORMAT -> int
# cNames : DWORD -> DWORD
# rpNames : LPCSTR* -> LPVOID
# ppResult : DS_NAME_RESULTA** out -> LPVOID
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。

関連項目

文字セット違い
使用する型