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

WdsCliCreateSession

関数
WDSサーバーへ接続し資格情報付きでセッションを作成する。
DLLWDSCLIENTAPI.dll呼出規約winapiSetLastErrorあり対応OSWindows Vista 以降

シグネチャ

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

HRESULT WdsCliCreateSession(
    LPWSTR pwszServer,
    WDS_CLI_CRED* pCred,   // optional
    HANDLE* phSession
);

パラメーター

名前方向説明
pwszServerLPWSTRin接続先WDSサーバ名(Unicode)。NULLでマルチキャストセッションを作成。
pCredWDS_CLI_CRED*inoptional認証に使用するWDS_CLI_CRED資格情報へのポインタ。不要ならNULL可。
phSessionHANDLE*out作成されたセッションのハンドルを受け取るポインタ。

戻り値の型: HRESULT

各言語での呼び出し定義

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

HRESULT WdsCliCreateSession(
    LPWSTR pwszServer,
    WDS_CLI_CRED* pCred,   // optional
    HANDLE* phSession
);
[DllImport("WDSCLIENTAPI.dll", SetLastError = true, ExactSpelling = true)]
static extern int WdsCliCreateSession(
    [MarshalAs(UnmanagedType.LPWStr)] string pwszServer,   // LPWSTR
    IntPtr pCred,   // WDS_CLI_CRED* optional
    IntPtr phSession   // HANDLE* out
);
<DllImport("WDSCLIENTAPI.dll", SetLastError:=True, ExactSpelling:=True)>
Public Shared Function WdsCliCreateSession(
    <MarshalAs(UnmanagedType.LPWStr)> pwszServer As String,   ' LPWSTR
    pCred As IntPtr,   ' WDS_CLI_CRED* optional
    phSession As IntPtr   ' HANDLE* out
) As Integer
End Function
' pwszServer : LPWSTR
' pCred : WDS_CLI_CRED* optional
' phSession : HANDLE* out
Declare PtrSafe Function WdsCliCreateSession Lib "wdsclientapi" ( _
    ByVal pwszServer As LongPtr, _
    ByVal pCred As LongPtr, _
    ByVal phSession As LongPtr) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。
import ctypes
from ctypes import wintypes

WdsCliCreateSession = ctypes.windll.wdsclientapi.WdsCliCreateSession
WdsCliCreateSession.restype = ctypes.c_int
WdsCliCreateSession.argtypes = [
    wintypes.LPCWSTR,  # pwszServer : LPWSTR
    ctypes.c_void_p,  # pCred : WDS_CLI_CRED* optional
    ctypes.c_void_p,  # phSession : HANDLE* out
]
# GetLastError: use ctypes.GetLastError() (or ctypes.WinDLL(use_last_error=True))
require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('WDSCLIENTAPI.dll')
WdsCliCreateSession = Fiddle::Function.new(
  lib['WdsCliCreateSession'],
  [
    Fiddle::TYPE_VOIDP,  # pwszServer : LPWSTR
    Fiddle::TYPE_VOIDP,  # pCred : WDS_CLI_CRED* optional
    Fiddle::TYPE_VOIDP,  # phSession : HANDLE* out
  ],
  Fiddle::TYPE_INT)
#[link(name = "wdsclientapi")]
extern "system" {
    fn WdsCliCreateSession(
        pwszServer: *mut u16,  // LPWSTR
        pCred: *mut WDS_CLI_CRED,  // WDS_CLI_CRED* optional
        phSession: *mut *mut core::ffi::c_void  // HANDLE* out
    ) -> i32;
}
// crates: windows-sys provides ready-made bindings for this API.
$sig = @"
[DllImport("WDSCLIENTAPI.dll", SetLastError = true)]
public static extern int WdsCliCreateSession([MarshalAs(UnmanagedType.LPWStr)] string pwszServer, IntPtr pCred, IntPtr phSession);
"@
$api = Add-Type -MemberDefinition $sig -Name 'WDSCLIENTAPI_WdsCliCreateSession' -Namespace Win32 -PassThru
# $api::WdsCliCreateSession(pwszServer, pCred, phSession)
#uselib "WDSCLIENTAPI.dll"
#func global WdsCliCreateSession "WdsCliCreateSession" sptr, sptr, sptr
; WdsCliCreateSession pwszServer, varptr(pCred), phSession   ; 戻り値は stat
; pwszServer : LPWSTR -> "sptr"
; pCred : WDS_CLI_CRED* optional -> "sptr"
; phSession : HANDLE* out -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
出力引数:
#uselib "WDSCLIENTAPI.dll"
#cfunc global WdsCliCreateSession "WdsCliCreateSession" wstr, var, sptr
; res = WdsCliCreateSession(pwszServer, pCred, phSession)
; pwszServer : LPWSTR -> "wstr"
; pCred : WDS_CLI_CRED* optional -> "var"
; phSession : HANDLE* out -> "sptr"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
出力引数:
; HRESULT WdsCliCreateSession(LPWSTR pwszServer, WDS_CLI_CRED* pCred, HANDLE* phSession)
#uselib "WDSCLIENTAPI.dll"
#cfunc global WdsCliCreateSession "WdsCliCreateSession" wstr, var, intptr
; res = WdsCliCreateSession(pwszServer, pCred, phSession)
; pwszServer : LPWSTR -> "wstr"
; pCred : WDS_CLI_CRED* optional -> "var"
; phSession : HANDLE* out -> "intptr"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	wdsclientapi = windows.NewLazySystemDLL("WDSCLIENTAPI.dll")
	procWdsCliCreateSession = wdsclientapi.NewProc("WdsCliCreateSession")
)

// pwszServer (LPWSTR), pCred (WDS_CLI_CRED* optional), phSession (HANDLE* out)
r1, _, err := procWdsCliCreateSession.Call(
	uintptr(unsafe.Pointer(windows.StringToUTF16Ptr(pwszServer))),
	uintptr(pCred),
	uintptr(phSession),
)
_ = err  // syscall.Errno (valid when the call sets last-error)
_ = r1   // HRESULT
function WdsCliCreateSession(
  pwszServer: PWideChar;   // LPWSTR
  pCred: Pointer;   // WDS_CLI_CRED* optional
  phSession: Pointer   // HANDLE* out
): Integer; stdcall;
  external 'WDSCLIENTAPI.dll' name 'WdsCliCreateSession';
result := DllCall("WDSCLIENTAPI\WdsCliCreateSession"
    , "WStr", pwszServer   ; LPWSTR
    , "Ptr", pCred   ; WDS_CLI_CRED* optional
    , "Ptr", phSession   ; HANDLE* out
    , "Int")   ; return: HRESULT
●WdsCliCreateSession(pwszServer, pCred, phSession) = DLL("WDSCLIENTAPI.dll", "int WdsCliCreateSession(char*, void*, void*)")
# 呼び出し: WdsCliCreateSession(pwszServer, pCred, phSession)
# pwszServer : LPWSTR -> "char*"
# pCred : WDS_CLI_CRED* optional -> "void*"
# phSession : HANDLE* out -> "void*"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。
const std = @import("std");

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

typedef WdsCliCreateSessionNative = Int32 Function(Pointer<Utf16>, Pointer<Void>, Pointer<Void>);
typedef WdsCliCreateSessionDart = int Function(Pointer<Utf16>, Pointer<Void>, Pointer<Void>);
final WdsCliCreateSession = DynamicLibrary.open('WDSCLIENTAPI.dll')
    .lookupFunction<WdsCliCreateSessionNative, WdsCliCreateSessionDart>('WdsCliCreateSession');
// pwszServer : LPWSTR -> Pointer<Utf16>
// pCred : WDS_CLI_CRED* optional -> Pointer<Void>
// phSession : HANDLE* out -> Pointer<Void>
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function WdsCliCreateSession(
  pwszServer: PWideChar;   // LPWSTR
  pCred: Pointer;   // WDS_CLI_CRED* optional
  phSession: Pointer   // HANDLE* out
): Integer; stdcall;
  external 'WDSCLIENTAPI.dll' name 'WdsCliCreateSession';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "WdsCliCreateSession"
  c_WdsCliCreateSession :: CWString -> Ptr () -> Ptr () -> IO Int32
-- pwszServer : LPWSTR -> CWString
-- pCred : WDS_CLI_CRED* optional -> Ptr ()
-- phSession : HANDLE* out -> Ptr ()
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let wdsclicreatesession =
  foreign "WdsCliCreateSession"
    ((ptr uint16_t) @-> (ptr void) @-> (ptr void) @-> returning int32_t)
(* pwszServer : LPWSTR -> (ptr uint16_t) *)
(* pCred : WDS_CLI_CRED* optional -> (ptr void) *)
(* phSession : HANDLE* out -> (ptr void) *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)
(cffi:define-foreign-library wdsclientapi (t "WDSCLIENTAPI.dll"))
(cffi:use-foreign-library wdsclientapi)

(cffi:defcfun ("WdsCliCreateSession" wds-cli-create-session :convention :stdcall) :int32
  (pwsz-server (:string :encoding :utf-16le))   ; LPWSTR
  (p-cred :pointer)   ; WDS_CLI_CRED* optional
  (ph-session :pointer))   ; HANDLE* out
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $WdsCliCreateSession = Win32::API::More->new('WDSCLIENTAPI',
    'int WdsCliCreateSession(LPCWSTR pwszServer, LPVOID pCred, HANDLE phSession)');
# my $ret = $WdsCliCreateSession->Call($pwszServer, $pCred, $phSession);
# pwszServer : LPWSTR -> LPCWSTR
# pCred : WDS_CLI_CRED* optional -> LPVOID
# phSession : HANDLE* out -> HANDLE
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。

関連項目

使用する型