diff options
| author | Arthur de Jong <arthur@arthurdejong.org> | 2008-05-15 21:08:13 +0200 |
|---|---|---|
| committer | Arthur de Jong <arthur@arthurdejong.org> | 2008-05-15 21:08:13 +0200 |
| commit | 193b75adc658d65af5a91f3389f526a6128d4bca (patch) | |
| tree | 06face78735f3b1eb7107a86325218c4467f1a92 /nslcd/myldap.h | |
| parent | 9faca11ba13aa3a684ea1fbdcb0fce32a2b3fa55 (diff) | |
improve documentation for myldap_get_rdn_value() function
git-svn-id: http://arthurdejong.org/svn/nss-pam-ldapd/nss-ldapd@734 ef36b2f9-881f-0410-afb5-c4e39611909c
Diffstat (limited to 'nslcd/myldap.h')
| -rw-r--r-- | nslcd/myldap.h | 10 |
1 files changed, 5 insertions, 5 deletions
diff --git a/nslcd/myldap.h b/nslcd/myldap.h index 8242604..106d803 100644 --- a/nslcd/myldap.h +++ b/nslcd/myldap.h @@ -106,14 +106,14 @@ MUST_USE const char **myldap_get_values(MYLDAP_ENTRY *entry,const char *attr); /* Checks to see if the entry has the specified object class. */ MUST_USE int myldap_has_objectclass(MYLDAP_ENTRY *entry,const char *objectclass); -/* Get the RDN's value: eg. if the RDN was cn=lukeh, getrdnvalue(entry,cn) - would return lukeh. If the attribute was not found in the DN or on error - NULL is returned. This method may be used to get the "most authorative" - value for an attribute. */ +/* Get the RDN's value: eg. if the DN was cn=lukeh, ou=People, dc=example, + dc=com getrdnvalue(entry,cn) would return lukeh. If the attribute was not + found in the DN or if some error occurs NULL is returned. This method may + be used to get the "most authorative" value for an attribute. */ MUST_USE const char *myldap_get_rdn_value(MYLDAP_ENTRY *entry,const char *attr); /* Just like myldap_get_rdn_value() but use the supplied character sequence - and copy the result into the buffer. + and copies the result into the buffer. Returns a pointer to the start of the string on success and NULL on failure. */ MUST_USE const char *myldap_cpy_rdn_value(const char *dn,const char *attr, |