• Type: Integer (non-REXX), character representation of an integer (REXX)
• Length: 4 bytes (non-REXX)

ReturnCode contains the return code from the service.

• Type: Character string
• Length: 16 bytes

ConnectToken represents a logical connection between the application and a CPC, image, or other entity. The ConnectToken is an output parameter on the HWICONN service call.

In most cases, the ConnectToken specified must have originated from a HWICONN service call that was issued from the same address space as this service call. For BCPii REXX execs running under TSO/E or ISV-provided REXX environments, the ConnectToken specified must have originated from a HWICONN service call that was issued from the same task.

If the ListType is HWI_LIST_CPCS, HWI_LIST_LOCALCPC, or HWI_LIST_LOCALIMAGE, this parameter is not relevant and is ignored.

If the ListType is HWI_LIST_IMAGES, this request must either be directed to a specific CPC or to a specific user-defined image group. Therefore, a connect token that represents an already active HWI CPC connection or user-defined image group must be specified.

If the ListType is HWI_LIST_CAPRECS, any of the activation profile (APROF) list types, or HWI_LIST_IMAGEGROUPS, this request must be directed to a specific CPC. Therefore, a connect token that represents an already active HWI CPC connection must be specified.

For a ListType of HWI_LIST_EVENTS, the connect token must represent an already active HWI CPC or image connection, depending on which events are to be listed. If a list of CPC events is required, the connect token must represent an active CPC connection. Likewise, if a list of image events is required, the connect token must represent an active image connection.

• Type: Integer (non-REXX), character representation of an integer (REXX)
• Length: 4 bytes (non-REXX)

ListType specifies the type of request for the service.

• Type: Integer
• Length: 4 bytes

NumofDataItemsReturned contains the number of data items returned in the answer area.

• Type: Pointer (non-REXX), stem variable (REXX)
• Length: 4 bytes (non-REXX)

Non-REXX:

AnswerArea_Ptr specifies the address of the answer area where the requested data is returned.

REXX:

A list of the requested objects is returned in an array form of x.n; where x is the user-defined AnswerArea stem variable and n is the n-th element in the stem array.

The AnswerArea.0 stem variable counter holds the number of items returned.

The ListType specified determines the format of the returned data.

ListType	Data to be returned (non-REXX)	Data to be returned (REXX)
HWI_LIST_CPCS	A string comprised of a list of blank-separated concatenated 17-character CPC network addresses. Each network address is in the form of a 1- through 8-character netid, followed by a period, and followed by a 1- through 8-character network addressable unit (NAU) name. The network address is padded with trailing blanks if the total string length of the network address is less than 17 characters. Example: net1.cpc01.	A stem array list of CPC network addresses. Each network address is in the form of a 1- through 8-character netid, followed by a period, and followed by a 1- through 8-character network addressable unit (NAU) name. Example: net1.cpc01.
HWI_LIST_IMAGES	A string comprised of a list of blank-separated concatenated 8-character image names padded with trailing blanks.	A stem array list of image names.
HWI_LIST_EVENTS	A 128-bit string. The first 96 bits (12 bytes) is an eye-catcher value of HWIEVENTBLCK. The last 32 bits represents events already registered for notification. These events were registered by previous HWIEVENT ADD service calls. The returned event indicators are specific to the ConnectToken specified. These indicators are mapped by the type structure HWI_EVENTIDS_TYPE from the BCPii services interface declaration file. If a particular indicator is on, that event is active for this connection.	A stem array list of Boolean values of the EventIDs, which are represented by the EventIDs tail labels defined in HWICIREX. For example, if x is the answerarea stem variable, the returned Boolean data indicates the event registration status. x.Hwi_Event_CmdResp = 1  (on) x.Hwi_Event_StatusChg = 0 (off)      :      : x.Hwi_Event_PowerChange  = 0 (off)   Note: This ListType is not supported for REXX execs running in the TSO/E or ISV-provided REXX environments.
HWI_LIST_CAPRECS	A string comprised of a list of blank-separated concatenated 8-character CAPREC names padded with trailing blanks.	A stem array list of CAPREC names.
HWI_LIST_LOCALCPC	A 17–character string representing the CPC network address of the local CPC. The network address is in the form of a 1- to 8-character netid, followed by a period, followed by a 1- to 8-character network addressable unit (NAU) name. The network address is padded with trailing blanks.	The CPC network address of the local CPC is returned in the first and only element in the stem array. The network address is in the form of a 1- through 8-character netid, followed by a period, and followed by a 1- through 8-character network addressable unit (NAU) name.
HWI_LIST_LOCALIMAGE	An 8–character string representing the image name of the local image (LPAR) padded with trailing blanks.	The image name of the local image (LPAR) is returned in the first and only element in the stem array.
HWI_LIST_RESET_ACTPROF	A string comprised of a list of concatenated 16–character reset activation profile names padded with trailing blanks.	A stem array list of reset activation profile names.
HWI_LIST_IMAGE_ACTPROF	A string comprised of a list of concatenated 16–character image activation profile names padded with trailing blanks.	A stem array list of image activation profile names.
HWI_LIST_LOAD_ACTPROF	A string comprised of a list of concatenated 16–character load activation profile names padded with trailing blanks.	A stem array list of load activation profile names.
HWI_LIST_IMAGEGROUPS	A null-terminated string of null-separated user-defined image group names.	A stem array list of user-defined image group names.

• Type: Integer
• Length: 4 bytes

For example, if a ListType of HWI_LIST_CPCS is specified and the current HMC LAN has 7 CPCs connected to it, at least 17 bytes x 7 CPCs + the number of blank spaces among the CPCs = 119 + 6 = 125 bytes of data are required for the AnswerArea.

• Type: Character string (non-REXX), stem variable (REXX)
• Length: 32 bytes (non-REXX)

See BCPii communication error reason codes for a partial list of the descriptive communication transport error return codes and suggested actions.