Purpose
Create an iSeries™ data queue object. After the
object is created it can be opened using the cwbDQ_OpenEx API.
It will have the attributes that you specify in the attributes handle.
Syntax
unsigned int CWB_ENTRY cwbDQ_CreateEx(
cwbCO_SysHandle sysHandle,
const char *queue,
const char *library,
cwbDQ_Attr queueAttributes,
cwbSV_ErrHandle errorHandle);
Parameters
- cwbCO_SysHandle sysHandle - input
- Handle to a system object
- const char * queue - input
- Pointer to the data queue name contained in an ASCIIZ string.
- const char * library - input
- Pointer to the library name contained in an ASCIIZ string. If this pointer
is NULL then the current library will be used (set library to "*CURLIB").
- cwbDQ_Attr queueAttributes - input
- Handle to the attributes for the data queue.
- cwbSV_ErrHandle errorHandle - output
- Any returned messages will be written to this object. It is created with
the cwbSV_CreateErrHandle API. The messages may be retrieved
through the cwbSV_GetErrText API. If the parameter is set
to zero, no messages will be retrieved.
Return Codes
The following list shows common return
values.
- CWB_OK
- Successful completion.
- CWB_COMMUNICATIONS_ERROR
- A communications error occurred.
- CWB_SERVER_PROGRAM_NOT_FOUND
- iSeries application
not found.
- CWB_HOST_NOT_FOUND
- iSeries system
inactive or does not exist.
- CWB_INVALID_POINTER
- Bad or null pointer.
- CWB_SECURITY_ERROR
- A security error has occurred.
- CWB_LICENSE_ERROR
- A license error has occurred.
- CWB_CONFIG_ERROR
- A configuration error has occurred.
- CWBDQ_INVALID_ATTRIBUTE_HANDLE
- Invalid attributes handle.
- CWBDQ_BAD_QUEUE_NAME
- Queue name is incorrect.
- CWBDQ_BAD_LIBRARY_NAME
- Library name is incorrect.
- CWBDQ_REJECTED_USER_EXIT
- Command rejected by user exit program.
- CWBDQ_USER_EXIT_ERROR
- Error in user exit program.
- CWBDQ_USER_EXIT_ERROR
- Error in user exit program.
- CWBDQ_LIBRARY_NOT_FOUND
- Library not found on system.
- CWBDQ_NO_AUTHORITY
- No authority to library.
- CWBDQ_QUEUE_EXISTS
- Queue already exists.
- CWBDQ_QUEUE_SYNTAX
- Queue syntax is incorrect.
- CWBDQ_LIBRARY_SYNTAX
- Library syntax is incorrect.
- CWB_NOT_ENOUGH_MEMORY
- Insufficient memory; may have failed to allocate temporary buffer.
- CWB_NON_REPRESENTABLE_UNICODE_CHAR
- One or more input Unicode characters have no representation in the code
page being used.
- CWB_API_ERROR
- General API failure.
- CWB_INVALID_HANDLE
- Invalid system handle.
Usage
This function requires that you have previously
issued the following APIs:
- cwbDQ_CreateSystem
- cwbDQ_CreateAttr
- cwbDQ_SetMaxRecLen