Parameter values set by the application

SOC-FUNCTION

A 16-byte character field containing INET6_IS_SRCADDR.

NAME

Specifies the AF_INET6 socket address structure for the address that is to be tested.

Requirement: You must specify an AF_INET6 address. You can specify an IPv6 address, or an IPv4-mapped IPv6 address.

The IPv6 socket address structure specifies the following fields:

FAMILY

A halfword binary field that specifies the IPv6 addressing family. For TCP/IP the value is the decimal value 19, indicating AF_INET6.

PORT

A halfword binary field. This field is ignored by INET6_IS_SRCADDR processing.

FLOWINFO

A fullword binary field that specifies the traffic class and flow label. This field is ignored by INET6_IS_SRCADDR processing.

IP-ADDRESS

A 16-byte binary field that is set to the 128-bit IPv6 IP address (network byte order) of the IP address to be tested.

Rule: Specify an IPv4 address by using its IPv4-mapped IPv6 address format.

SCOPE-ID

A fullword binary field that identifies a set of appropriate interfaces for the scope of the address that is specified in the IP-ADDRESS field. The value 0 indicates that the SCOPE-ID field does not identify the set of interfaces to be used.

Requirements:

If the IP address is a link-local address, this field must be set to a nonzero value.
If the IP address is not a link-local address, this field must be set to 0.

FLAGS

A fullword binary field that contains one or more valid IPV6_ADDR_PREFERENCES flags.

Flag name	Binary value	Decimal value	Description
IPV6_PREFER_SRC_HOME	X'00000001'	1	Test whether the input IP address is a home address.¹
IPV6_PREFER_SRC_COA	X'00000002'	2	Test whether the input IP address is a care-of address.²
IPV6_PREFER_SRC_TMP	X'00000004'	4	Test whether the input IP address is a temporary address.
IPV6_PREFER_SRC_PUBLIC	X'00000008'	8	Test whether the input IP address is a public address.
IPV6_PREFER_SRC_CGA	X'00000010'	16	Test whether the input IP address is cryptographically generated.²
IPV6_PREFER_SRC_NONCGA	X'00000020'	32	Test whether the input IP address is not cryptographically generated.¹
Note: Any valid IP address that is known to the stack satisfies this flag. z/OS® Communications Server does not support this type of address. The call always returns FALSE if this flag is specified with a valid IP address that is known to the stack.

Tips:

The SEZAINST(EZACOBOL) and SEZAINST(CBLOCK) samples contain mappings for these flags. For assembler programs, the flags are defined in the system maclib member BPXYSOCK.
Some of these flags are contradictory, for example:
- The flag IPV6_PREFER_SRC_HOME contradicts the flag IPV6_PREFER_SRC_COA.
- The flag IPV6_PREFER_SRC_CGA contradicts the flag IPV6_PREFER_SRC_NONCGA.
- The flag IPV6_PREFER_SRC_TMP contradicts the flags IPV6_PREFER_SRC_PUBLIC.
Result: If you specify contradictory flags in the call, the result is FALSE.