Verify Name (QCAVFYNM, QcaVerifyName) API
Required Parameter Group:
| 1 | Name information | Input | Char(*) |
| 2 | Format of name information | Input | Char(8) |
| 3 | Error code | I/O | Char(*) |
Service Program: QCAVFYNMS
Default Public Authority: *USE
Threadsafe: Yes
The Verify Name (QCAVFYNM, QcaVerifyName) API verifies an input value to determine if it is a valid system name. A CPF019D message is sent for an invalid name.
The Verify Name API lets you control how the name is verified based on the name type specified.
Authorities and Locks
None.
Required Parameter Group
- Name information
- INPUT; CHAR(*)
The information related to the name string. The format of this information depends on the specified Format name.
- Format of name information
- INPUT; CHAR(8)
The format of the name information specified. You must use the following Format name:
VFYN0100 Verify name format.
- Error code
- I/O; CHAR(*)
The structure in which to return error information. For the format of the structure, see Error code parameter.
VFYN0100 Format
The following table describes the information that is required in the VFYN0100 format. For detailed descriptions of the fields, see Field Descriptions.
| Offset | Type | Field | |
|---|---|---|---|
| Dec | Hex | ||
| 0 | 0 | BINARY(4) | Length of fixed data |
| 4 | 4 | BINARY(4) | Code character set ID (CCSID) |
| 8 | 8 | CHAR(10) | Name type |
| 18 | 12 | CHAR(1) | Monocase indicator |
| 19 | 13 | CHAR(1) | Reserved |
| 20 | 14 | BINARY(4) | Offset to name |
| 24 | 18 | BINARY(4) | Length of name |
| * | * | CHAR(*) | Name |
Field Descriptions
Coded character set ID (CCSID). The value of the coded character set ID (CCSID) associated with the name string to be verified. A CCSID value of zero indicates that the default CCSID in effect for the job should be used.
Length of fixed data. The length of the fixed data with specific constant value 28.
Length of name. The length of the name field. The maximum value allowed is 256 bytes.
Monocase indicator. The indicator to monocase the Name. The values allowed are:
| 0 | Do not monocase the Name. |
| 1 | Monocase the name prior to doing validation. |
Name. The character string to be verified as a valid or invalid name.
Name type. The name types allowed are:
| *NAME | Basic Name. The parameter value is a character string that represents a basic name. The first character is alphabetic (A-Z), $, # or @. The remaining characters are the same as the first character, but can also include the numbers 0 through 9, underscores (_) and periods. The name can also be a string of characters that begin and end with double quotation marks ("). |
| *SNAME | Simple Name. The parameter value is a character string that represents a simple name that follows the same naming rules as *NAME, except that no periods (.) are allowed. |
| *CNAME | Communications Name. The parameter value is a character string that represents a communications name that follows the same naming rules as *NAME, except that no periods (.) or underscores(_) are allowed. |
Offset to name. The offset to the name to be verified.
Reserved. Must be set to hexadecimal zeros.
Error Messages
| Message ID | Error Message Text |
|---|---|
| CPF019D E | Value &1 not valid as system name. |
| CPF019E E | Value of &1 for length of name field not valid. |
| CPF019F E | The type &1 is not allowed or valid. |
| CPF24B4 E | Severe error while addressing parameter list. |
| CPF3BDE E | CCSID &1 not supported by API. |
| CPF3C21 E | Format name &1 is not valid. |
| CPF3C39 E | Value for reserved field not valid. |
| CPF3CF1 E | Error code parameter not valid. |
API introduced: V6R1