ホーム › Networking.Ldap › ldap_next_attribute

ldap_next_attribute

関数

エントリから次の属性名を取得する。

DLLWLDAP32.dll文字セットANSI (-A)呼出規約cdecl対応OSWindows Vista 以降

シグネチャ

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

LPSTR ldap_next_attribute(
    LDAP* ld,
    LDAPMessage* entry,
    BerElement* ptr
);

パラメーター

名前	型	方向	説明
ld	LDAP*	inout	セッションハンドル。
entry	LDAPMessage*	inout	属性を順に処理する対象のエントリ。 ldap_first_entry または ldap_next_entry によって返されます。
ptr	BerElement*	inout	エントリ内の現在位置を内部的に追跡するために使用されるポインターのアドレス。

戻り値の型: LPSTR

公式ドキュメント

ldap_next_attribute 関数 (winldap.h) は、次の属性を返します。

戻り値

関数が成功した場合、現在の属性名を格納した null 終端文字列へのポインターを返します。順に処理する属性がこれ以上ない場合は NULL を返します。いずれの場合も、LDAP データ構造体のセッションエラーパラメーターは 0 に設定されます。

関数が失敗した場合は NULL を返し、LDAP データ構造体のセッションエラーパラメーターに LDAP エラーコードを設定します。

解説(Remarks)

エントリとともに返される属性型の一覧を順に処理するには、 ldap_next_attribute を ldap_first_attribute と組み合わせて使用します。取得した属性名は ldap_get_values の呼び出しに渡すことで、対応する値を取得できます。

ldap_next_attribute を呼び出すと、ptr パラメーターを通じて BerElement 構造体へのポインターが返されます。このポインターを次の ldap_next_attribute の呼び出しに渡すことで、属性一覧内の現在位置を追跡します。属性一覧の処理を終えた時点で ptr が NULL 以外の場合は、 ber_free (ptr, 0) を呼び出してポインターを解放してください。この呼び出しでは、2 番目のパラメーターに必ず 0 (ゼロ) を渡す必要があることに注意してください。

ldap_next_attribute 関数は、現在の属性名を格納した内部的に割り当てられたバッファーへのポインターを返します。このバッファーが不要になったら、 ldap_memfree を呼び出して解放してください。このバッファーは次回の ldap_first_attribute または ldap_next_attribute の呼び出しで上書きされるため、属性名を後続の処理のために保持する必要がある場合は、コピーを作成してください。

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

各言語での呼び出し定義

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

LPSTR ldap_next_attribute(
    LDAP* ld,
    LDAPMessage* entry,
    BerElement* ptr
);

[DllImport("WLDAP32.dll", CharSet = CharSet.Ansi, ExactSpelling = true, CallingConvention = CallingConvention.Cdecl)]
static extern IntPtr ldap_next_attribute(
    IntPtr ld,   // LDAP* in/out
    IntPtr entry,   // LDAPMessage* in/out
    IntPtr ptr   // BerElement* in/out
);

<DllImport("WLDAP32.dll", CharSet:=CharSet.Ansi, ExactSpelling:=True, CallingConvention:=CallingConvention.Cdecl)>
Public Shared Function ldap_next_attribute(
    ld As IntPtr,   ' LDAP* in/out
    entry As IntPtr,   ' LDAPMessage* in/out
    ptr As IntPtr   ' BerElement* in/out
) As IntPtr
End Function

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

import ctypes
from ctypes import wintypes

ldap_next_attribute = ctypes.cdll.wldap32.ldap_next_attribute
ldap_next_attribute.restype = wintypes.LPSTR
ldap_next_attribute.argtypes = [
    ctypes.c_void_p,  # ld : LDAP* in/out
    ctypes.c_void_p,  # entry : LDAPMessage* in/out
    ctypes.c_void_p,  # ptr : BerElement* in/out
]

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('WLDAP32.dll')
ldap_next_attribute = Fiddle::Function.new(
  lib['ldap_next_attribute'],
  [
    Fiddle::TYPE_VOIDP,  # ld : LDAP* in/out
    Fiddle::TYPE_VOIDP,  # entry : LDAPMessage* in/out
    Fiddle::TYPE_VOIDP,  # ptr : BerElement* in/out
  ],
  Fiddle::TYPE_VOIDP, Fiddle::Function::CDECL)

#[link(name = "wldap32")]
extern "C" {
    fn ldap_next_attribute(
        ld: *mut LDAP,  // LDAP* in/out
        entry: *mut LDAPMessage,  // LDAPMessage* in/out
        ptr: *mut BerElement  // BerElement* in/out
    ) -> *mut u8;
}
// crates: windows-sys provides ready-made bindings for this API.

$sig = @"
[DllImport("WLDAP32.dll", CharSet = CharSet.Ansi, CallingConvention = CallingConvention.Cdecl)]
public static extern IntPtr ldap_next_attribute(IntPtr ld, IntPtr entry, IntPtr ptr);
"@
$api = Add-Type -MemberDefinition $sig -Name 'WLDAP32_ldap_next_attribute' -Namespace Win32 -PassThru
# $api::ldap_next_attribute(ld, entry, ptr)

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

出力引数:

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