ATN Address Conversion Functions

Functions

void ATNds_free (void *ptr)
 Free a buffer which has been returned by ATNds_AFTN2AMHS or ATNds_AMHS2AFTN. More...
 
DS_Status ATNds_AFTN2AMHS (DS_Session *session, const DS_DN *registry_dn, const char *aftn_addr, char **orbuf_p, size_t *orbuf_len_p, DS_DN **userdn_p)
 Convert an AFTN address to the AMHS O/R address. If the user has an associated directory entry the distinguished name of that is returned as well. More...
 
DS_Status ATNds_AMHS2AFTN (DS_Session *session, const DS_DN *registry_dn, const char *x400_or_addr, char *aftn_buf, DS_DN **userdn_p)
 Return the AFTN address associated with the given AMHS O/R address. If the user has an associated directory entry the distinguished name of this is returned as well. More...
 

Detailed Description

Functions of the ATN directory service client API.

Function Documentation

void ATNds_free ( void *  ptr)

Free a buffer which has been returned by ATNds_AFTN2AMHS or ATNds_AMHS2AFTN.

Parameters
ptr[in] Pointer to buffer to free.
Returns
None
Examples:
atnds_test.c.
DS_Status ATNds_AFTN2AMHS ( DS_Session *  session,
const DS_DN *  registry_dn,
const char *  aftn_addr,
char **  orbuf_p,
size_t *  orbuf_len_p,
DS_DN **  userdn_p 
)

Convert an AFTN address to the AMHS O/R address. If the user has an associated directory entry the distinguished name of that is returned as well.

Parameters
session[in] An open directory session.
registry_dn[in] DN of ICAO or local registry.
aftn_addr[in] AFTN address to convert.
orbuf_p[out] Returned O/R address string, or NULL if the address could not be found.
orbuf_len_p[out] Length of returned buffer, or 0 if the address could not be found.
userdn_p[out] Returned DN (of user entry). NULL if none found.
Returns
DS_E_NOERROR on success or non-zero error code.

Note that DS_E_NOERROR can still be returned when the address could not be found.

Examples:
atnds_test.c.
DS_Status ATNds_AMHS2AFTN ( DS_Session *  session,
const DS_DN *  registry_dn,
const char *  x400_or_addr,
char *  aftn_buf,
DS_DN **  userdn_p 
)

Return the AFTN address associated with the given AMHS O/R address. If the user has an associated directory entry the distinguished name of this is returned as well.

Parameters
session[in] An open directory session.
registry_dn[in] DN of ICAO or local registry.
x400_or_addr[in] X400 O/R address to convert.
aftn_buf[out] A buffer of length 9 which will hold the returned AFTN address. This buffer is allocated and owned by the caller.
userdn_p[out] Returned DN (of user entry).
Returns
DS_E_NOERROR on success or non-zero error code.
Examples:
atnds_test.c.