> tibemsLookupParams
> Type
> Purpose
> Encapsulate parameters for LDAP lookup.

> Function | Description | Page
> tibemsLookupParams_Create | Create a new LDAP lookup context object. | 330
> tibemsLookupParams_Destroy | Destroy a lookup parameters object. | 331
> tibemsLookupParams_GetLdapServerUrl | Get the LDAP server URL. | 332
> tibemsLookupParams_SetLdapBaseDN | Set the LDAP base distinguished name. | 333
> tibemsLookupParams_SetLdapCAFile | Set the LDAP CA certificate file. | 334
> tibemsLookupParams_SetLdapCAPath | Set the LDAP CA certificate directory pathname. | 335
> tibemsLookupParams_SetLdapCertFile | Set the LDAP client certificate file. | 336
> tibemsLookupParams_SetLdapCiphers | Set SSL ciphers. | 337
> tibemsLookupParams_SetLdapConnType | Set the LDAP connection type. | 338
> tibemsLookupParams_SetLdapCredential | Set the LDAP credential (password). | 339
> tibemsLookupParams_SetLdapKeyFile | Set the LDAP client key file. | 340
> tibemsLookupParams_SetLdapPrincipal | Set the LDAP principal (user name). | 341
> tibemsLookupParams_SetLdapRandFile | Set a randomization data file. | 342
> tibemsLookupParams_SetLdapSearchScope | Set the LDAP search scope. | 343
> tibemsLookupParams_SetLdapServerUrl | Set the LDAP server URL. | 344

> tibemsLookupParams_Create
> Function
> Purpose
> Create a new lookup parameters object.
> C Declaration
> tibemsLookupParams
> tibemsLookupParams_Create(void);
> COBOL Call
> CALL "tibemsLookupParams_Create"
> RETURNING lparams
> END-CALL.

> | lparams has usage pointer.

> See Also
> tibemsLookupContext_CreateExternal on page 325
> tibemsLookupParams_Destroy
> Function
> Purpose
> Destroy a lookup parameters object.
> C Declaration
> void tibemsLookupParams_Destroy(
> tibemsLookupParams lparams );
> COBOL Call
> CALL "tibemsLookupParams_Destroy"
> USING BY VALUE lparams
> END-CALL.

> | lparams has usage pointer.

> Parameters

> Parameter | Description
> lparams | The function stores the new lookup context object in this location.

> tibemsLookupParams_GetLdapServerUrl
> Function
> Purpose
> Get the LDAP server URL.
> C Declaration
> char* tibemsLookupParams_GetLdapServerUrl(
> tibemsLookupParams lparams);
> COBOL Call
> CALL "tibemsLookupParams_GetLdapServerUrl"
> USING BY VALUE lparams
> END-CALL.

> | lparams has usage pointer.

> Parameters

> Parameter | Description
> lparams | Get the LDAP server URL from this external lookup context object.

> tibemsLookupParams_SetLdapBaseDN
> Function
> Purpose
> Set the LDAP base distinguished name.
> C Declaration
> tibems_status tibemsLookupParams_SetLdapBaseDN(
> tibemsLookupParams lparams,
> const char* basedn );
> COBOL Call
> CALL "tibemsLookupParams_SetLdapBaseDN"
> USING BY VALUE lparams,
> BY REFERENCE basedn,
> RETURNING tibems-status
> END-CALL.

> | lparams has usage pointer.

> Parameters

> Parameter | Description
> lparams | Set the property in this parameter object.
> basedn | Set the property to this distinguished name.

> Remarks
> This parameter is required for all LDAP lookup operations.
> tibemsLookupParams_SetLdapCAFile
> Function
> Purpose
> Set the LDAP CA certificate file.
> C Declaration
> tibems_status tibemsLookupParams_SetLdapCAFile(
> tibemsLookupParams lparams,
> const char* file );
> COBOL Call
> CALL "tibemsLookupParams_SetLdapCAFile"
> USING BY VALUE lparams,
> BY REFERENCE file,
> RETURNING tibems-status
> END-CALL.

> | lparams has usage pointer.

> Parameters

> Parameter | Description
> lparams | Set the property in this parameter object.
> path | Set the property to this filename.

> Remarks
> The client program reads the CA certificate from this file.
> tibemsLookupParams_SetLdapCAPath
> Function
> Purpose
> Set the LDAP CA certificate directory pathname.
> C Declaration
> tibems_status tibemsLookupParams_SetLdapCAPath(
> tibemsLookupParams lparams,
> const char* path );
> COBOL Call
> CALL "tibemsLookupParams_SetLdapCAPath"
> USING BY VALUE lparams,
> BY REFERENCE path,
> RETURNING tibems-status
> END-CALL.

> | lparams has usage pointer.

> Parameters

> Parameter | Description
> lparams | Set the property in this parameter object.
> path | Set the property to this directory pathname.

> Remarks
> Set this parameter when several certificate files are grouped in one directory. This parameter specifies that directory. The client program reads certificate files from this directory.
> tibemsLookupParams_SetLdapCertFile
> Function
> Purpose
> Set the LDAP client certificate file.
> C Declaration
> tibems_status tibemsLookupParams_SetLdapCertFile(
> tibemsLookupParams lparams,
> const char* file );
> COBOL Call
> CALL "tibemsLookupParams_SetLdapCertFile"
> USING BY VALUE lparams,
> BY REFERENCE file,
> RETURNING tibems-status
> END-CALL.

> | lparams has usage pointer.

> Parameters

> Parameter | Description
> lparams | Set the property in this parameter object.
> file | Set the property to this filename.

> Remarks
> The client program reads the client certificate from this file.
> Set this parameter when the LDAP server requires clients to present certificates as identification.
> tibemsLookupParams_SetLdapCiphers
> Function
> Purpose
> Set SSL ciphers.
> C Declaration
> tibems_status tibemsLookupParams_SetLdapCiphers(
> tibemsLookupParams lparams,
> const char* ciphers );
> COBOL Call
> CALL "tibemsLookupParams_SetLdapCiphers"
> USING BY VALUE lparams,
> BY REFERENCE ciphers,
> RETURNING tibems-status
> END-CALL.

> | lparams has usage pointer.

> Parameters

> Parameter | Description
> lparams | Set the property in this parameter object.
> ciphers | Set the property to specify these ciphers (as a colon-separated list). For example: "EDH-RSA-DES-CBC3-SHA:EDH-DSS-DES-CBC3-SHA:DES-CBC3-SHA:DES-CBC3-MD5:DHE-DSS-RC4-SHA:IDEA-CBC-SHA:RC4-SHA:RC4-MD5:IDEA-CBC-MD5:RC2-CBC-MD5:RC4-MD5:RC4-64-MD5:EXP1024-DHE-DSS-RC4-SHA:EXP1024-RC4-SHA:EXP1024-DHE-DSS-DES-CBC-SHA:EXP1024-DES-CBC-SHA:EXP1024-RC2-CBC-MD5:EXP1024-RC4-MD5:EDH-RSA-DES-CBC-SHA:EDH-DSS-DES-CBC-SHA:DES-CBC-SHA:DES-CBC-MD5:EXP-EDH-RSA-DES-CBC-SHA:EXP-EDH-DSS-DES-CBC-SHA:EXP-DES-CBC-SHA:EXP-RC2-CBC-MD5:EXP-RC4-MD5:EXP-RC2-CBC-MD5:EXP-RC4-MD5"

> Remarks
> Set this parameter when using secure LDAP connections.
> The LDAP server configures a similar list of ciphers. SSL communication uses the strongest ciphers in the intersection of the server and client cipher lists.
> tibemsLookupParams_SetLdapConnType
> Function
> Purpose
> Set the LDAP connection type.
> C Declaration
> tibems_status tibemsLookupParams_SetLdapConnType(
> tibemsLookupParams lparams,
> const char* type );
> COBOL Call
> CALL "tibemsLookupParams_SetLdapConnType"
> USING BY VALUE lparams,
> BY REFERENCE type,
> RETURNING tibems-status
> END-CALL.

> | lparams has usage pointer.

> Parameters

> Parameter | Description
> lparams | Set the property in this parameter object.
> type | Set the property to this type. When this value is not set, it specifies a simple (non-secure) connection. Either "ldaps" or "startTLS" specify secure connections.

> tibemsLookupParams_SetLdapCredential
> Function
> Purpose
> Set the LDAP credential (password).
> C Declaration
> tibems_status tibemsLookupParams_SetLdapCredential(
> tibemsLookupParams lparams,
> const char* credential );
> COBOL Call
> CALL "tibemsLookupParams_SetLdapCredential"
> USING BY VALUE lparams,
> BY REFERENCE credential,
> RETURNING tibems-status
> END-CALL.

> | lparams has usage pointer.

> Parameters

> Parameter | Description
> lparams | Set the property in this parameter object.
> credential | Set the property to this credential (password).

> tibemsLookupParams_SetLdapKeyFile
> Function
> Purpose
> Set the LDAP client key file.
> C Declaration
> tibems_status tibemsLookupParams_SetLdapKeyFile(
> tibemsLookupParams lparams,
> const char* file );
> COBOL Call
> CALL "tibemsLookupParams_SetLdapKeyFile"
> USING BY VALUE lparams,
> BY REFERENCE file,
> RETURNING tibems-status
> END-CALL.

> | lparams has usage pointer.

> Parameters

> Parameter | Description
> lparams | Set the property in this parameter object.
> file | Set the property to this filename.

> Remarks
> The client program reads the private key for the client certificate from this (encrypted) file.
> Set this parameter when the LDAP server requires clients to present certificates as identification.
> tibemsLookupParams_SetLdapPrincipal
> Function
> Purpose
> Set the LDAP principal (user name).
> C Declaration
> tibems_status tibemsLookupParams_SetLdapPrincipal(
> tibemsLookupParams lparams,
> const char* principal );
> COBOL Call
> CALL "tibemsLookupParams_SetLdapPrincipal"
> USING BY VALUE lparams,
> BY REFERENCE principal,
> RETURNING tibems-status
> END-CALL.

> | lparams has usage pointer.

> Parameters

> Parameter | Description
> lparams | Set the property in this parameter object.
> principal | Set the property to this principal (user name).

> Remarks
> This parameter is required for all LDAP lookup operations.
> tibemsLookupParams_SetLdapRandFile
> Function
> Purpose
> Set a randomization data file.
> C Declaration
> tibems_status tibemsLookupParams_SetLdapRandFile(
> tibemsLookupParams lparams,
> const char* file );
> COBOL Call
> CALL "tibemsLookupParams_SetLdapRandFile"
> USING BY VALUE lparams,
> BY REFERENCE file,
> RETURNING tibems-status
> END-CALL.

> | lparams has usage pointer.

> Parameters

> Parameter | Description
> lparams | Set the property in this parameter object.
> file | Set the property to this filename.

> Remarks
> The client program reads random data for security computations from this file.
> Set this parameter when the operating system does not provide a random data service.
> tibemsLookupParams_SetLdapSearchScope
> Function
> Purpose
> Set the LDAP search scope.
> C Declaration
> tibems_status tibemsLookupParams_SetLdapSearchScope(
> tibemsLookupParams lparams,
> const char* scope );
> COBOL Call
> CALL "tibemsLookupParams_SetLdapSearchScope"
> USING BY VALUE lparams,
> BY REFERENCE scope,
> RETURNING tibems-status
> END-CALL.

> | lparams has usage pointer.

> Parameters

> Parameter | Description
> lparams | Set the property in this parameter object.
> scope | Set the property to this search scope.

> Remarks
> This parameter is required for all LDAP lookup operations.
> tibemsLookupParams_SetLdapServerUrl
> Function
> Purpose
> Set the LDAP server URL.
> C Declaration
> tibems_status tibemsLookupParams_SetLdapServerUrl(
> tibemsLookupParams lparams,
> const char* url);
> COBOL Call
> CALL "tibemsLookupParams_SetLdapServerUrl"
> USING BY VALUE lparams,
> BY REFERENCE url,
> RETURNING tibems-status
> END-CALL.

> | lparams has usage pointer.

> Parameters

> Parameter | Description
> lparams | Set the property in this parameter object.
> url | Set the property to this URL.

> Remarks
> This parameter is required for all LDAP lookup operations.

Copyright © TIBCO Software Inc. All Rights Reserved.