Copyright: Helpfile Generated by VB HelpWriter!


Product Features
VBX Support for AS/400® Data Queues

Overview

Properties

Getting Started

Create

          Clear

          Delete

          Send

          Put

          Set Mode

          Receive

Return Codes

JDB Soft-Systems


Create
VBX Support for AS/400® Data Queues

Create

This option will create a new nonkeyed data queue on the attatched AS/400.

When using this function the following attributes must be specified in order for the function to complete without error.

Data Queue Name

System Name

Maximum Data Queue Length

Sequence

Force

Authority

Sender Identification

Text

Return Codes

JDB Soft-Systems


Clear
VBX Support for AS/400® Data Queues

Clear

This option will allow the user to remove all message entries from an existing data queue.  Once run the data contained within the data queue is no longer available for retrieval.

The following entries must be set priot to running this function:

Data Queue Name

System Name

JDB Soft-Systems


Delete
VBX Support for AS/400® Data Queues

Delete

This function permanently removes the data queue from the specified system.  When using this function it is important to remember that there is NO UNDO function directly supported by this product.  The only recovery would be to restore the data queue from your previous backup.

The following entries must be set priot to running this function:

Data Queue Name

System Name

JDB Soft-Systems


Receive
VBX Support for AS/400® Data Queues

Receive

This will retrieve data or messages from a nonkeyed data queue.  This function will cause all other activity to be suspended until the data is retrieved.  If no data or message is present the function will wait the specified time or until a message is received, which ever is shorter.

The following entries must be made to ensure no error is generated by this function :

Data Queue Name

System Name

Wait Time

Sender ID

Data to Receive

Length

Sender information

JDB Soft-Systems


Send Data
VBX Support for AS/400® Data Queues

Send Data

Use this function to send data or messages to an nonkeyed data queue.  This function unlike the Putfunction waits until for an acknowledgement from the host is received before the client program continues processing.

When using this function the following attributes must be specified in order for the function to complete without error.

Data Queue Name

System Name

Data to Send

Length of data being sent

JDB Soft-Systems


Set Mode
VBX Support for AS/400® Data Queues  Set Mode

This function will set the conversion mode for the current data queue operations.  This MUST be the first function called in order for all other function to correct work.

The following fields must be specified

System Name

Mode  which will be set to 1 for most all situtations.  Please refer to you Client Access/400® manuals for complete information on all possible values.

JDB Soft-Systems


Put Data
VBX Support for AS/400® Data Queues

Put Data

This function will send data or messages to the specified nonkeyed data queue.  To assistance with improved performance the client running this function will receive control back to the application before an acknowledgement from the host has been received.  If performance is not an issue use the Sendfunction or if performance is a concern use the PUT function for all entries except the last which will be done using the Sendfunction.

The following entries must be specified :

Data Queue Name

System Name

Data to Send

Data Length

See also Send

JDB Soft-Systems


Overview
VBX Support for AS/400® Data Queues

Overview

VBX400DQ custom control allows the user to have access to AS/400® data queues.  To be able to use the VBX (design and/or runtime mode) the user must have Client Access/400® running on the client along with the DQ Server.  The serve can be started via the Client Access/400 program group.

Copyright - License

LICENSE AGREEMENT - AS/400 Data Queue Custom Control

Version 1.0 July 1995

By using this product, you are agreeing to be bound by the following agreement:

This software product is copyrighted, and all rights are reserved by JDB Soft-Systems. You are licensed to use this software on a restricted number of computers. You may copy the software to facilitate your use of it on as many computers as licensed users, as specified. Making copies for any other purpose violates U.S. and international copyright

laws.

This software is sold AS IS without warranty of any kind, either expressed or implied, including but not limited to the implied warranties of merchantability and fitness for a particular purpose.  The authors assume no liability for any alleged or actual damages arising from the use of this software.

VBX400DQ.VBX

You have a royalty-free right to reproduce and distribute the control file VBX400DQ.VBX with any application that you develop and distribute.

JDB Soft-Systems


Data Queue Name

The name of the data queue that you are working with or attempting to work with following all AS/400® naming guidlines.  The maximum length is 10 characters.

This cannot be a AS/400® qualified name for an function except CREATE.  When using the CREATE function the name of the library for which the data queue is to be created must be specified.

ie :	MYLIB/MYDATAQ	-	Create

*LIBL/MYDATAQ	-	All other functions.

JDB Soft-Systems


System Name

The name of the system that is attatched to the currently active Client Access/400® router.

JDB Soft-Systems


Maximum Data Queue Length

This is the maximum length of a message on the data queue.  The maximum length of the VBX400DQ product is 4000 even though the AS/400® is well greater.

JDB Soft-Systems


Sequence

Specifies how data is retrieved from the data queue.  The valid options are

Last in, First out (LIFO)

First in, First out (FIFO)

JDB Soft-Systems


Authority

Specifies the level of authority granted to users who do not have specified authority to the queue.  The possible levels are :

All Authority

Exclude

Change

Use

Library create

For a complete discussion of the different means of the authority level see your IBM manuals.

JDB Soft-Systems


Sender Identification

This field will be used to hold the sender information if it has been requested by the receive function.

JDB Soft-Systems


Text

The description that is placed on the object.

JDB Soft-Systems


Force

This entry specifies whether messages sent to the data queue are forced to auxiliary storage before they are added to the queue.

JDB Soft-Systems


Return Codes

The return code will indicate if an error has been encountered while processing the last function.  It will contain a non-zero when an error has been detected, you can at this point check the CPFMsgid field to get the actual CPF message id or the return message.

JDB Soft-Systems


Data Length
Length

This is the size in bytes of the data being received or is being sent to the data queue or the size of the data queue to create.

JDB Soft-Systems


Data to Send

JDB Soft-Systems


Notices

JDB Soft-Systems


Wait Time

The number of seconds to wait for a message to be receive on the data queue if one is not currently present during a receive function.

A positive number indicates the number of seconds

A negative number indicates a wait until a message is received.

A value of 0 get the message or return with no wait.

JDB Soft-Systems


Data to Receive

This will be the area where the data receive from the Receive function is placed.

JDB Soft-Systems


Getting Started
VBX Support for AS/400® Data Queues

Getting Started

Getting started on creating your first application is very simple.  The only required function that must be run is the SET MODE funtion.  After running Set Mode you may use any of the other functions to accomplish the task you have at hand.  Included with the VBX is a sample application which makes use of all the function and can be modified and/or changed to your specifications.

Please forward any questions, comments or suggested enhancements to my attention via E-Mail (102426,2247) and I will get an answer to you as fast as possible.

Thank You for your purchase.

JDB Soft-Systems


Properties
VBX Support for AS/400® Data Queues

Properties

DQ_ReceiveWait

DQ_Library

DQ_SystemName

DQ_QueueName

DQ_Action	- This is a hidden propterty.

DQ_ReturnCode

DQ_Function

DQ_Mode

DQ_Length

DQ_Text

DQ_Authority

DQ_SenderID

DQ_Force

DQ_Sequence

DQ_ReturnMessage	- This is a hidden propterty.

DQ_CPFMsgid	- This is a hidden propterty.

DQ_ReceiveData	- This is a hidden propterty.

DQ_SenderInfo	- This is a hidden propterty.

DQ_SendData

JDB Soft-Systems


Library
VBX Support for AS/400® Data Queues

Library

The name of the library where the data queue object can be found or is to be created.

JDB Soft-Systems


Action
VBX Support for AS/400® Data Queues

Action

Use this option ONLY after you have set all the correct properties for the desired function.  By setting this property you will cause the selected function to be run and any return codes to be generated.

JDB Soft-Systems


Function
VBX Support for AS/400® Data Queues Function

This is the task the user is going to perform when the Actionproperty is set to run.  The first Function that MUST be run prior to any other options it the Set Mode function.  By running the Set Mode function you will set for the duraction of the application the translation characteristics that will be used.

JDB Soft-Systems


CPF
CPFMsgid

The AS/400® CPF message ID used to identify an error encountered by the run function.

JDB Soft-Systems


Return Message

The complete error message that was produced by the just run function.

JDB Soft-Systems