Standards
Standards / Extensions |
C or C++ |
Dependencies |
z/OS® UNIX |
both |
|
Format
#include <sys/server.h>
int __server_classify(server_classify_t handle,
server_classify_field_t field,
const char *value);
General description
The __server_classify() function sets fields in a classify data area. The
'classify data area' is created and initialized by invoking the __server_classify_create()
function. This 'classify data area' is subsequently used with the
__server_pwu() function to interface with WorkLoad Manager (WLM).
The handle argument is a 'classify data area' created
on a previous invocation of the __server_classify_create() function.
The field argument must be one of the following values:
- _SERVER_CLASSIFY_ACCTINFO
- Set the accounting information. When specified, value contains
a NULL-terminated character string of up to 143 characters containing
the account information for the work unit to be created.
- _SERVER_CLASSIFY_COLLECTION
- Set the customer defined name for a group of associated packages.
When specified, value contains a NULL-terminated character string
of up to 18 characters containing the collection name associated with
the work unit to be created.
- _SERVER_CLASSIFY_CONNECTION
- Set the name associated with the environment creating the work
unit. When specified, value contains a NULL-terminated character string
of up to 8 characters containing the connection name associated with
the environment creating the work unit.
- _SERVER_CLASSIFY_CONNTKN
- Set the connection token that was returned on a call to __ConnectWorkMgr()
or __ConnectServerMgr(). When specified, value contains a integer
value representing the connection token returned on a call to __ConnectWorkMgr()
or __ConnectServerMgr().
- _SERVER_CLASSIFY_CORRELATION
- Set the name associated with the user/program creating the work
unit. When specified, value contains a NULL-terminated character
string of up to 12 characters that contains the name associated with
the user/program creating the work unit.
- _SERVER_CLASSIFY_LUNAME
- Set the local LU name associated with the requester. When specified,
value contains a NULL-terminated character string of up to 8 characters
containing the local LU name associated with the requester.
- _SERVER_CLASSIFY_NETID
- Set the network ID associated with the requester. When specified,
value contains a NULL-terminated character string of up to 8 characters
containing the network ID associated with the requester.
- _SERVER_CLASSIFY_PACKAGE
- Set the package name for a set of associated SQL statements.
When specified, value contains a NULL-terminated character string
of up to 8 characters containing the package name associated with
the work unit to be created.
- _SERVER_CLASSIFY_PERFORM
- Set the performance group number (PGN) associated with the work
unit. When specified, value contains a NULL-terminated character
string of up to 8 characters containing the PGN associated with the
work unit to be created.
- _SERVER_CLASSIFY_PLAN
- Set the access plan name for a set of associated SQL statements.
When specified, value contains a NULL-terminated character string
of up to 8 characters containing the access plan name associated with
the work unit to be created.
- _SERVER_CLASSIFY_PRCNAME
- Set the DB2® stored SQL
procedure name associated with the work unit. When specified, value
contains a NULL-terminated character string of up to 18 characters
containing the DB2 stored SQL
procedure name associated with the work unit to be created.
- _SERVER_CLASSIFY_PRIORITY
- Set the priority associated with the work unit to be created.
When specified, value contains a integer value representing the priority
of the work unit to be created.
- _SERVER_CLASSIFY_RPTCLSNM@
- Set the pointer to an 8 character buffer to receive the output
report class name for the work unit to be created. When specified,
value contains the pointer to an 8 character buffer to receive the
output report class name for the work unit to be created.
- _SERVER_CLASSIFY_SCHEDENV
- Set the scheduling environment information. When specified,
value contains a NULL-terminated character string of up to 16 characters
containing the scheduling environment name associated with the work
unit.
- _SERVER_CLASSIFY_SERVCLS@
- Set the pointer to an integer field to receive the output service
class for the work unit to be created. When specified, value contains
the pointer to a integer field to receive the output service class
for the work unit to be created.
- _SERVER_CLASSIFY_SERVCLSNM@
- Set the pointer to an 8 character buffer to receive the output
service class name for the work unit to be created. When specified,
value contains the pointer to an 8 character buffer to receive the
output service class name for the work unit to be created.
- _SERVER_CLASSIFY_SOURCELU
- Set the source LU name associated with the requester. When
specified, value contains a NULL-terminated character string of up
to 17 characters containing the source LU name associated with the
requester.
- _SERVER_CLASSIFY_SUBCOLN
- Set the subsystem collection name. When specified, the value
contains a NULL-terminated character string of up to 8 characters,
containing the subsystem collection name associated with the work
unit.
- _SERVER_CLASSIFY_SUBSYSTEM_PARM
- Set the transaction subsystem parameter. When specified, value contains
a NULL-terminated character string of up to 255 characters containing
the subsystem parameter being used for the __server_pwu() call.
- _SERVER_CLASSIFY_TRANSACTION_CLASS
- Set the transaction class. When specified, value contains
a NULL-terminated character string of up to 8 characters containing
the name of the transaction class for the __server_pwu() call.
- _SERVER_CLASSIFY_TRANSACTION_NAME
- Set the transaction name. When specified, value contains
a NULL-terminated character string of up to 8 characters containing
the name of the transaction for the __server_pwu() call.
- _SERVER_CLASSIFY_USERID
- Set the user ID. When specified, value contains a
NULL-terminated character string of up to 8 characters containing
the name of the user for the __server_pwu() call.
The value argument is the value that the specified 'classify
data area' field is to be set to. (For valid values, refer to z/OS MVS Programming: Workload Management Services.)
The classify area is specific to the calling thread. The __server_classify() function
call must be done on the same thread of execution as the __server_classify_create().
Use of the classify area by another thread can lead to unpredictable
results.
Returned value
If successful, __server_classify() returns 0.
If unsuccessful,
__server_classify() returns -1 and sets errno to one of
the following values:
- Error Code
- Description
- E2BIG
- The character string specified for a classify field is too large.
- EINVAL
- The classify field symbolic is not valid.