Hans Leidekker : wldap32: Document the modify and modrdn functions.
Alexandre Julliard
julliard at wine.codeweavers.com
Tue May 16 13:54:22 CDT 2006
Module: wine
Branch: refs/heads/master
Commit: c0364ef571cd650e5c830c1b7476420d8bb31a81
URL: http://source.winehq.org/git/?p=wine.git;a=commit;h=c0364ef571cd650e5c830c1b7476420d8bb31a81
Author: Hans Leidekker <hans at it.vu.nl>
Date: Tue May 16 14:37:17 2006 +0200
wldap32: Document the modify and modrdn functions.
---
dlls/wldap32/modify.c | 99 +++++++++++++++++++++++++++++++++++++++++++++++++
dlls/wldap32/modrdn.c | 88 ++++++++++++++++++++++++++++++++++++++++++++
2 files changed, 187 insertions(+), 0 deletions(-)
diff --git a/dlls/wldap32/modify.c b/dlls/wldap32/modify.c
index 55ac776..52f263b 100644
--- a/dlls/wldap32/modify.c
+++ b/dlls/wldap32/modify.c
@@ -41,6 +41,11 @@ #include "wldap32.h"
WINE_DEFAULT_DEBUG_CHANNEL(wldap32);
+/***********************************************************************
+ * ldap_modifyA (WLDAP32.@)
+ *
+ * See ldap_modifyW.
+ */
ULONG ldap_modifyA( WLDAP32_LDAP *ld, PCHAR dn, LDAPModA *mods[] )
{
ULONG ret = LDAP_NOT_SUPPORTED;
@@ -73,6 +78,26 @@ #endif
return ret;
}
+/***********************************************************************
+ * ldap_modifyW (WLDAP32.@)
+ *
+ * Change an entry in a directory tree (asynchronous operation).
+ *
+ * PARAMS
+ * ld [I] Pointer to an LDAP context.
+ * dn [I] DN of the entry to change.
+ * mods [I] Pointer to an array of LDAPModW structures, each
+ * specifying an attribute and its values to change.
+ *
+ * RETURNS
+ * Success: Message ID of the modify operation.
+ * Failure: An LDAP error code.
+ *
+ * NOTES
+ * Call ldap_result with the message ID to get the result of
+ * the operation. Cancel the operation by calling ldap_abandon
+ * with the message ID.
+ */
ULONG ldap_modifyW( WLDAP32_LDAP *ld, PWCHAR dn, LDAPModW *mods[] )
{
ULONG ret = LDAP_NOT_SUPPORTED;
@@ -112,6 +137,11 @@ #endif
return ret;
}
+/***********************************************************************
+ * ldap_modify_extA (WLDAP32.@)
+ *
+ * See ldap_modify_extW.
+ */
ULONG ldap_modify_extA( WLDAP32_LDAP *ld, PCHAR dn, LDAPModA *mods[],
PLDAPControlA *serverctrls, PLDAPControlA *clientctrls, ULONG *message )
{
@@ -157,6 +187,29 @@ #endif
return ret;
}
+/***********************************************************************
+ * ldap_modify_extW (WLDAP32.@)
+ *
+ * Change an entry in a directory tree (asynchronous operation).
+ *
+ * PARAMS
+ * ld [I] Pointer to an LDAP context.
+ * dn [I] DN of the entry to change.
+ * mods [I] Pointer to an array of LDAPModW structures, each
+ * specifying an attribute and its values to change.
+ * serverctrls [I] Array of LDAP server controls.
+ * clientctrls [I] Array of LDAP client controls.
+ * message [O] Message ID of the modify operation.
+ *
+ * RETURNS
+ * Success: LDAP_SUCCESS
+ * Failure: An LDAP error code.
+ *
+ * NOTES
+ * Call ldap_result with the message ID to get the result of
+ * the operation. The serverctrls and clientctrls parameters are
+ * optional and should be set to NULL if not used.
+ */
ULONG ldap_modify_extW( WLDAP32_LDAP *ld, PWCHAR dn, LDAPModW *mods[],
PLDAPControlW *serverctrls, PLDAPControlW *clientctrls, ULONG *message )
{
@@ -204,6 +257,11 @@ #endif
return ret;
}
+/***********************************************************************
+ * ldap_modify_ext_sA (WLDAP32.@)
+ *
+ * See ldap_modify_ext_sW.
+ */
ULONG ldap_modify_ext_sA( WLDAP32_LDAP *ld, PCHAR dn, LDAPModA *mods[],
PLDAPControlA *serverctrls, PLDAPControlA *clientctrls )
{
@@ -249,6 +307,27 @@ #endif
return ret;
}
+/***********************************************************************
+ * ldap_modify_ext_sW (WLDAP32.@)
+ *
+ * Change an entry in a directory tree (synchronous operation).
+ *
+ * PARAMS
+ * ld [I] Pointer to an LDAP context.
+ * dn [I] DN of the entry to change.
+ * mods [I] Pointer to an array of LDAPModW structures, each
+ * specifying an attribute and its values to change.
+ * serverctrls [I] Array of LDAP server controls.
+ * clientctrls [I] Array of LDAP client controls.
+ *
+ * RETURNS
+ * Success: LDAP_SUCCESS
+ * Failure: An LDAP error code.
+ *
+ * NOTES
+ * The serverctrls and clientctrls parameters are optional and
+ * should be set to NULL if not used.
+ */
ULONG ldap_modify_ext_sW( WLDAP32_LDAP *ld, PWCHAR dn, LDAPModW *mods[],
PLDAPControlW *serverctrls, PLDAPControlW *clientctrls )
{
@@ -295,6 +374,11 @@ #endif
return ret;
}
+/***********************************************************************
+ * ldap_modify_sA (WLDAP32.@)
+ *
+ * See ldap_modify_sW.
+ */
ULONG ldap_modify_sA( WLDAP32_LDAP *ld, PCHAR dn, LDAPModA *mods[] )
{
ULONG ret = LDAP_NOT_SUPPORTED;
@@ -327,6 +411,21 @@ #endif
return ret;
}
+/***********************************************************************
+ * ldap_modify_sW (WLDAP32.@)
+ *
+ * Change an entry in a directory tree (synchronous operation).
+ *
+ * PARAMS
+ * ld [I] Pointer to an LDAP context.
+ * dn [I] DN of the entry to change.
+ * attrs [I] Pointer to an array of LDAPModW structures, each
+ * specifying an attribute and its values to change.
+ *
+ * RETURNS
+ * Success: LDAP_SUCCESS
+ * Failure: An LDAP error code.
+ */
ULONG ldap_modify_sW( WLDAP32_LDAP *ld, PWCHAR dn, LDAPModW *mods[] )
{
ULONG ret = LDAP_NOT_SUPPORTED;
diff --git a/dlls/wldap32/modrdn.c b/dlls/wldap32/modrdn.c
index a572fe7..8e1c12b 100644
--- a/dlls/wldap32/modrdn.c
+++ b/dlls/wldap32/modrdn.c
@@ -40,6 +40,11 @@ #include "wldap32.h"
WINE_DEFAULT_DEBUG_CHANNEL(wldap32);
+/***********************************************************************
+ * ldap_modrdnA (WLDAP32.@)
+ *
+ * See ldap_modrdnW.
+ */
ULONG ldap_modrdnA( WLDAP32_LDAP *ld, PCHAR dn, PCHAR newdn )
{
ULONG ret = LDAP_NOT_SUPPORTED;
@@ -70,6 +75,25 @@ #endif
return ret;
}
+/***********************************************************************
+ * ldap_modrdnW (WLDAP32.@)
+ *
+ * Change the RDN of a directory entry (asynchronous operation).
+ *
+ * PARAMS
+ * ld [I] Pointer to an LDAP context.
+ * dn [I] DN of the entry to change.
+ * newdn [I] New DN for the entry.
+ *
+ * RETURNS
+ * Success: Message ID of the modrdn operation.
+ * Failure: An LDAP error code.
+ *
+ * NOTES
+ * Call ldap_result with the message ID to get the result of
+ * the operation. Cancel the operation by calling ldap_abandon
+ * with the message ID.
+ */
ULONG ldap_modrdnW( WLDAP32_LDAP *ld, PWCHAR dn, PWCHAR newdn )
{
ULONG ret = LDAP_NOT_SUPPORTED;
@@ -106,6 +130,11 @@ #endif
return ret;
}
+/***********************************************************************
+ * ldap_modrdn2A (WLDAP32.@)
+ *
+ * See ldap_modrdn2W.
+ */
ULONG ldap_modrdn2A( WLDAP32_LDAP *ld, PCHAR dn, PCHAR newdn, INT delete )
{
ULONG ret = LDAP_NOT_SUPPORTED;
@@ -136,6 +165,26 @@ #endif
return ret;
}
+/***********************************************************************
+ * ldap_modrdn2W (WLDAP32.@)
+ *
+ * Change the RDN of a directory entry (asynchronous operation).
+ *
+ * PARAMS
+ * ld [I] Pointer to an LDAP context.
+ * dn [I] DN of the entry to change.
+ * newdn [I] New DN for the entry.
+ * delete [I] Delete old DN?
+ *
+ * RETURNS
+ * Success: Message ID of the modrdn operation.
+ * Failure: An LDAP error code.
+ *
+ * NOTES
+ * Call ldap_result with the message ID to get the result of
+ * the operation. Cancel the operation by calling ldap_abandon
+ * with the message ID.
+ */
ULONG ldap_modrdn2W( WLDAP32_LDAP *ld, PWCHAR dn, PWCHAR newdn, INT delete )
{
ULONG ret = LDAP_NOT_SUPPORTED;
@@ -172,6 +221,11 @@ #endif
return ret;
}
+/***********************************************************************
+ * ldap_modrdn2_sA (WLDAP32.@)
+ *
+ * See ldap_modrdn2_sW.
+ */
ULONG ldap_modrdn2_sA( WLDAP32_LDAP *ld, PCHAR dn, PCHAR newdn, INT delete )
{
ULONG ret = LDAP_NOT_SUPPORTED;
@@ -202,6 +256,21 @@ #endif
return ret;
}
+/***********************************************************************
+ * ldap_modrdn2_sW (WLDAP32.@)
+ *
+ * Change the RDN of a directory entry (synchronous operation).
+ *
+ * PARAMS
+ * ld [I] Pointer to an LDAP context.
+ * dn [I] DN of the entry to change.
+ * newdn [I] New DN for the entry.
+ * delete [I] Delete old DN?
+ *
+ * RETURNS
+ * Success: LDAP_SUCCESS
+ * Failure: An LDAP error code.
+ */
ULONG ldap_modrdn2_sW( WLDAP32_LDAP *ld, PWCHAR dn, PWCHAR newdn, INT delete )
{
ULONG ret = LDAP_NOT_SUPPORTED;
@@ -232,6 +301,11 @@ #endif
return ret;
}
+/***********************************************************************
+ * ldap_modrdn_sA (WLDAP32.@)
+ *
+ * See ldap_modrdn_sW.
+ */
ULONG ldap_modrdn_sA( WLDAP32_LDAP *ld, PCHAR dn, PCHAR newdn )
{
ULONG ret = LDAP_NOT_SUPPORTED;
@@ -262,6 +336,20 @@ #endif
return ret;
}
+/***********************************************************************
+ * ldap_modrdn_sW (WLDAP32.@)
+ *
+ * Change the RDN of a directory entry (synchronous operation).
+ *
+ * PARAMS
+ * ld [I] Pointer to an LDAP context.
+ * dn [I] DN of the entry to change.
+ * newdn [I] New DN for the entry.
+ *
+ * RETURNS
+ * Success: LDAP_SUCCESS
+ * Failure: An LDAP error code.
+ */
ULONG ldap_modrdn_sW( WLDAP32_LDAP *ld, PWCHAR dn, PWCHAR newdn )
{
ULONG ret = LDAP_NOT_SUPPORTED;
More information about the wine-cvs
mailing list