Common Arguments to Directory Operations

Handling of common arguments to directory operations. This includes service parameters, extension handling, etc. More...

Functions
DS_Status	DS_CommonArgs_New (DS_CommonArgs **cp)
	Allocate a new DS_CommonArgs structure. More...
DS_Status	DS_CommonArgs_Delete (DS_CommonArgs *cp)
	Delete a DS_CommonArgs structure. More...
DS_Status	DS_CommonArgs_SetBoolParam (DS_CommonArgs *args, int param, unsigned char bool_val)
	Set a boolean parameter in the DS_CommonArgs structure. More...
DS_Status	DS_CommonArgs_GetBoolParam (const DS_CommonArgs *args, int param, unsigned char *bool_val_p)
	Get the value of a boolean parameter in the DS_CommonArgs structure. More...
DS_Status	DS_CommonArgs_SetIntParam (DS_CommonArgs *args, int param, int int_val)
	Set an integer parameter in the DS_CommonArgs structure. More...
DS_Status	DS_CommonArgs_GetIntParam (const DS_CommonArgs *args, int param, int *int_val_p)
	Get the value of an integer parameter in the DS_CommonArgs structure. More...
DS_Status	DS_CommonArgs_SetBytesParam (DS_CommonArgs *args, int param, unsigned char *bytes, int bytes_len)
	Set an octet string parameter in the DS_CommonArgs structure. More...
DS_Status	DS_CommonArgs_GetBytesParam (const DS_CommonArgs *args, int param, unsigned char **bytes, int *bytes_len)
	Get the value of an integer parameter in the DS_CommonArgs structure. More...

Detailed Description

Handling of common arguments to directory operations. This includes service parameters, extension handling, etc.

Supported common arguments include:

• DS_SVC_OPT_PREFERCHAIN
• DS_SVC_OPT_CHAININGPROHIBIT
• DS_SVC_OPT_LOCALSCOPE
• DS_SVC_OPT_DONTUSECOPY
• DS_SVC_OPT_DONTDEREFALIAS
• DS_SVC_OPT_SEARCHALIASES
• DS_EXT_OPT_USEALIASONUPDATE
• DS_SVC_OPT_SUBENTRIES
• DS_SVC_OPT_COPYSHALLDO
• DS_SVC_OPT_ATTRSONLY
• DS_SVC_PRIORITY
• DS_SVC_TIMELIMIT
• DS_SVC_SIZELIMIT
• DS_EXT_OPT_MANAGEDSAIT
• DS_SEC_SIGNED
• DS_SEC_ENCRYPTED
• DS_SEC_DISABLEVERIFICATION
• DS_SVC_PASSWORDPOLICY
• DS_SVC_OPT_PAGESIZE

For example:

DS_CommonArgs *ca;
DS_Status status;
 
status = DS_CommonArgs_New( &ca );
status = DS_CommonArgs_SetBoolParam( ca,
                                     DS_SVC_OPT_DONTDEREFALIAS,
                                     1 );
status = DS_CommonArgs_SetIntParam( ca,
                                    DS_SVC_SIZELIMIT,
                                    20 );
 
status = DS_SearchSync( ds, base_dn, "(cn=*)",
                        DSScopeSubtree, NULL,
                        ca,
                        &indication );
 
status = DS_CommonArgs_Delete( ca );

Function Documentation

DS_CommonArgs_New()

DS_Status DS_CommonArgs_New

(

DS_CommonArgs **

cp

)

Allocate a new DS_CommonArgs structure.

Parameters

[out]

cp

Return pointer. The caller should delete this using DS_CommonArgs_Delete().

Return values

DS_E_BADPARAM	If cp was NULL
DS_E_NOERROR	A DS_CommonArgs was returned

DS_CommonArgs_Delete()

DS_Status DS_CommonArgs_Delete

(

DS_CommonArgs *

cp

)

Delete a DS_CommonArgs structure.

Parameters

[in]

cp

Structure to delete.

Return values

DS_E_BADPARAM	If cp was NULL
DS_E_NOERROR	The DS_CommonArgs was deleted

DS_CommonArgs_SetBoolParam()

DS_Status DS_CommonArgs_SetBoolParam	(	DS_CommonArgs *	args,
		int	param,
		unsigned char	bool_val
	)

Set a boolean parameter in the DS_CommonArgs structure.

Parameters

[in]	args	Target data structure.
[in]	param	Parameter identifier.
[in]	bool_val	Parameter value.

Return values

DS_E_BADPARAM	Either args was NULL, or param was an unrecognized common argument, or does not allow a boolean value
DS_E_NOERROR	The DS_CommonArgs was updated

DS_CommonArgs_GetBoolParam()

DS_Status DS_CommonArgs_GetBoolParam	(	const DS_CommonArgs *	args,
		int	param,
		unsigned char *	bool_val_p
	)

Get the value of a boolean parameter in the DS_CommonArgs structure.

Parameters

[in]	args	Source data structure.
[in]	param	Parameter identifier.
[in]	bool_val_p	Parameter value.

Return values

DS_E_BADPARAM	Either args was NULL, or param was an unrecognized common argument, or does not allow a boolean value
DS_E_NOERROR	The boolean value was returned
DS_E_NOTFOUND	If the param was not found in args

DS_CommonArgs_SetIntParam()

DS_Status DS_CommonArgs_SetIntParam	(	DS_CommonArgs *	args,
		int	param,
		int	int_val
	)

Set an integer parameter in the DS_CommonArgs structure.

Parameters

[in]	args	Target data structure.
[in]	param	Parameter identifier.
[in]	int_val	Parameter value.

Return values

DS_E_BADPARAM	Either args was NULL, or param was an unrecognized common argument, or does not allow an integer value.
DS_E_NOERROR	The DS_CommonArgs was updated

DS_CommonArgs_GetIntParam()

DS_Status DS_CommonArgs_GetIntParam	(	const DS_CommonArgs *	args,
		int	param,
		int *	int_val_p
	)

Get the value of an integer parameter in the DS_CommonArgs structure.

Parameters

[in]	args	Source data structure.
[in]	param	Parameter identifier.
[in]	int_val_p	Parameter value.

Return values

DS_E_BADPARAM	Either args was NULL, or param was an unrecognized common argument, or does not allow an integer value.
DS_E_NOERROR	The integer value was returned
DS_E_NOTFOUND	If the param was not found in args

DS_CommonArgs_SetBytesParam()

DS_Status DS_CommonArgs_SetBytesParam	(	DS_CommonArgs *	args,
		int	param,
		unsigned char *	bytes,
		int	bytes_len
	)

Set an octet string parameter in the DS_CommonArgs structure.

Parameters

[in]	args	Target data structure.
[in]	param	Parameter identifier.
[in]	bytes	Parameter value.
[in]	bytes_len	Length of value.

Return values

DS_E_BADPARAM	Either args was NULL, or param was an unrecognized common argument, or does not allow an integer value.
DS_E_NOERROR	The DS_CommonArgs was updated

DS_CommonArgs_GetBytesParam()

DS_Status DS_CommonArgs_GetBytesParam	(	const DS_CommonArgs *	args,
		int	param,
		unsigned char **	bytes,
		int *	bytes_len
	)

Get the value of an integer parameter in the DS_CommonArgs structure.

Parameters

[in]	args	Source data structure.
[in]	param	Parameter identifier.
[in]	bytes_p	Parameter value.
[in]	bytes_len_p	Length of parameter value.

Return values

DS_E_BADPARAM	Either args was NULL, or param was an unrecognized common argument, or does not allow an integer value.
DS_E_NOERROR	The integer value was returned
DS_E_NOTFOUND	If the param was not found in args