ldap_connect

関数

LDAPサーバーへ実際に接続を確立する。

DLLWLDAP32.dll呼出規約cdecl対応OSWindows Vista 以降

シグネチャ

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

DWORD ldap_connect(
    LDAP* ld,
    LDAP_TIMEVAL* timeout
);

パラメーター

名前	型	方向	説明
ld	LDAP*	inout	ldap_init から取得したセッションハンドル。
timeout	LDAP_TIMEVAL*	inout	接続を確立しようとする際に、タイムアウトするまでに費やす秒数を指定する LDAP_TIMEVAL 構造体へのポインター。NULL の場合、関数は既定のタイムアウト値を使用します。

戻り値の型: DWORD

公式ドキュメント

ldap_connect 関数は、サーバーとの接続を確立します。

戻り値

関数が成功した場合は、LDAP_SUCCESS が返されます。

関数が失敗した場合は、エラーコードが返されます。詳細については、Return Values を参照してください。

解説(Remarks)

サーバーとの接続を確立するために、クライアントが ldap_connect を呼び出すことは必須ではありませんが、呼び出しておくことが望ましいプログラミング手法です。接続が存在しない場合は、他の関数 (たとえば ldap_bind_s) が内部でこの呼び出しを実行します。ただし、アプリケーションのこの部分をトラブルシューティングする必要がある場合、ldap_bind_s などの他の関数を呼び出す前に接続を確立しておくと、接続が失敗した際に問題を切り分けることができます。また、接続ブロックに対して追加のオプションを指定することもできます。たとえば、クライアントは ldap_init を呼び出してセッションを初期化した後、NULL 以外の timeout パラメーター値を指定して ldap_connect を呼び出すことで、指定したタイムアウトでサーバーに接続できます。

ldap_connect の呼び出しが成功すると、クライアントは匿名ユーザーとして LDAP サーバーに接続されます。セッションハンドルが不要になったら、ldap_unbind を呼び出して解放してください。

ldap_connect の呼び出しが失敗した場合も、エラー回復のために不要になった時点で、ldap_unbind を呼び出してセッションハンドルを解放してください。

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

各言語での呼び出し定義

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

DWORD ldap_connect(
    LDAP* ld,
    LDAP_TIMEVAL* timeout
);

[DllImport("WLDAP32.dll", ExactSpelling = true, CallingConvention = CallingConvention.Cdecl)]
static extern uint ldap_connect(
    IntPtr ld,   // LDAP* in/out
    IntPtr timeout   // LDAP_TIMEVAL* in/out
);

<DllImport("WLDAP32.dll", ExactSpelling:=True, CallingConvention:=CallingConvention.Cdecl)>
Public Shared Function ldap_connect(
    ld As IntPtr,   ' LDAP* in/out
    timeout As IntPtr   ' LDAP_TIMEVAL* in/out
) As UInteger
End Function

' ld : LDAP* in/out
' timeout : LDAP_TIMEVAL* in/out
Declare PtrSafe Function ldap_connect Lib "wldap32" ( _
    ByVal ld As LongPtr, _
    ByVal timeout As LongPtr) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。

import ctypes
from ctypes import wintypes

ldap_connect = ctypes.cdll.wldap32.ldap_connect
ldap_connect.restype = wintypes.DWORD
ldap_connect.argtypes = [
    ctypes.c_void_p,  # ld : LDAP* in/out
    ctypes.c_void_p,  # timeout : LDAP_TIMEVAL* in/out
]

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('WLDAP32.dll')
ldap_connect = Fiddle::Function.new(
  lib['ldap_connect'],
  [
    Fiddle::TYPE_VOIDP,  # ld : LDAP* in/out
    Fiddle::TYPE_VOIDP,  # timeout : LDAP_TIMEVAL* in/out
  ],
  -Fiddle::TYPE_INT, Fiddle::Function::CDECL)

#[link(name = "wldap32")]
extern "C" {
    fn ldap_connect(
        ld: *mut LDAP,  // LDAP* in/out
        timeout: *mut LDAP_TIMEVAL  // LDAP_TIMEVAL* in/out
    ) -> u32;
}
// crates: windows-sys provides ready-made bindings for this API.

$sig = @"
[DllImport("WLDAP32.dll", CallingConvention = CallingConvention.Cdecl)]
public static extern uint ldap_connect(IntPtr ld, IntPtr timeout);
"@
$api = Add-Type -MemberDefinition $sig -Name 'WLDAP32_ldap_connect' -Namespace Win32 -PassThru
# $api::ldap_connect(ld, timeout)

#uselib "WLDAP32.dll"
#func global ldap_connect "ldap_connect" sptr, sptr
; ldap_connect varptr(ld), varptr(timeout)   ; 戻り値は stat
; ld : LDAP* in/out -> "sptr"
; timeout : LDAP_TIMEVAL* in/out -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。

出力引数:

#uselib "WLDAP32.dll"
#cfunc global ldap_connect "ldap_connect" var, var
; res = ldap_connect(ld, timeout)
; ld : LDAP* in/out -> "var"
; timeout : LDAP_TIMEVAL* in/out -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。#uselib "WLDAP32.dll"
#cfunc global ldap_connect "ldap_connect" sptr, sptr
; res = ldap_connect(varptr(ld), varptr(timeout))
; ld : LDAP* in/out -> "sptr"
; timeout : LDAP_TIMEVAL* in/out -> "sptr"
; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは varptr(変数))。