 | HP OpenVMS System Services Reference ManualHP OpenVMS System Services Reference Manual
$GETQUIWReturns information about queues and jobs initiated from those queues.The $SNDJBC service is the major interface to the Job Controller, whichis the queue and accounting manager. For a discussion of the differenttypes of job and queue, see the Description section of $SNDJBC.The $GETQUIW service completes synchronously; that is, it returns tothe caller with the requested information. For asynchronous completion,use the Get Queue Information ($GETQUI) service; $GETQUI returns to thecaller after queuing the information request, without waiting for theinformation to be returned. In all other respects, $GETQUIW is identical to $GETQUI. For moreinformation about $GETQUIW, refer to the description of $GETQUI in thismanual. For additional information about system service completion, refer tothe Synchronize ($SYNCH) service.
FormatSYS$GETQUIW [efn] ,func [,context] [,itmlst] [,iosb] [,astadr] [,astprm]
C Prototypeint sys$getquiw (unsigned int efn, unsigned short int func, unsignedint *context, void *itmlst, struct _iosb *iosb, void(*astadr)(__unknown_params), int astprm);
$GETRMIReturns system performance information about the local system.
FormatSYS$GETRMI [efn] [,nullarg] [,nullarg] ,itmlst [,iosb] [,astadr][,astprm]
C Prototypeint sys$getrmi (unsigned int efn, unsigned int nullarg, unsigned intnullarg, void *itmlst, struct _iosb *iosb, void(*astadr)(__unknown_params), int astprm);
Argumentsefn
| OpenVMS usage: | ef_number | | type: | longword (unsigned) | | access: | read only | | mechanism: | by value |
Number of event flag to be set when the $GETRMI request completes. Theefn argument is a longword containing this number;however, $GETRMI uses only the low order byte.nullarg
| OpenVMS usage: | null_arg | | type: | longword (unsigned) | | access: | read only | | mechanism: | by value |
Placeholding argument reserved to HP.nullarg
| OpenVMS usage: | null_arg | | type: | longword (unsigned) | | access: | read only | | mechanism: | by value |
Placeholding argument reserved to HP.itmlst
| OpenVMS usage: | item_list_3 | | type: | longword (unsigned) | | access: | read only | | mechanism: | by reference |
Item list specifying which information is to be returned about thelocal node. The itmlst argument is the address of alist of item descriptors, each of which describes an item ofinformation. The list of descriptors is terminated by a longword of 0.The following diagram depicts the structure of a single item descriptor:
 The following table defines the item descriptor fields: | Descriptor Field | Definition | | Buffer length | A word containing a user-supplied integer specifying the length (in bytes) of the buffer in which $GETRMI is to write the information. The length of the buffer needed depends upon the item code specified in the item code field. If the buffer length is too small, $GETRMI truncates the data. | | Item code | A word containing a user-supplied code specifying the item of information that $GETRMI is to return. The RMIDEF macro defines these codes. A description of each item code is given in the item codes section. | | Buffer address | A longword containing the user-supplied address of a buffer in which $GETRMI returns the requested information. | | Return length address | A longword containing the user-supplied address of a word in which $GETRMI writes the length in bytes of the information returned. | iosb
| OpenVMS usage: | io_status_block | | type: | quadword (unsigned) | | access: | write only | | mechanism: | by reference |
I/O status block to receive the final completion status. Theiosb argument is the address of the quadword I/Ostatus block.astadr
| OpenVMS usage: | ast_procedure | | type: | procedure value | | access: | call without stack unwinding | | mechanism: | by reference |
AST service routine to be executed when $GETRMI completes. Theastadr argument is the address of this routine.astprm
| OpenVMS usage: | user_arg | | type: | longword (unsigned) | | access: | read only | | mechanism: | by value |
AST parameter to be passed to the AST service routine specified by theastadr argument.
Item CodesRMI$_ACCESSReturns the count of file name lookup operations in file directories.Because this number is a longword, the buffer length field in the itemdescriptor should specify 4 (bytes). RMI$_ACCLCKReturns the systemwide count of access locks.Because this number is a longword, the buffer length field in the itemdescriptor should specify 4 (bytes). RMI$_ALLOCReturns the number of QIO requests that caused allocation of disk space.Because this number is a longword, the buffer length field in the itemdescriptor should specify 4 (bytes). RMI$_ARRLOCPKReturns the accumulated systemwide count of arriving local DECnetpackets.Because this number is a longword, the buffer length field in the itemdescriptor should specify 4 (bytes). RMI$_ARRTRAPKReturns the accumulated systemwide count of arriving transit DECnetpackets.Because this number is a longword, the buffer length field in the itemdescriptor should specify 4 (bytes). RMI$_BADFLTSReturns the accumulated systemwide count of bad-list faults.Because this number is a longword, the buffer length field in the itemdescriptor should specify 4 (bytes). RMI$_BLKINReturns the accumulated systemwide count of blocking ASTs queued thatoriginated on a remote system and were processed on the local system.Because this number is a longword, the buffer length field in the itemdescriptor should specify 4 (bytes). RMI$_BLKLOCReturns the accumulated systemwide count of blocking ASTs queued thatoriginated and were processed on the local system.Because this number is a longword, the buffer length field in the itemdescriptor should specify 4 (bytes). RMI$_BLKOUTReturns the accumulated systemwide count of blocking ASTs queued thatoriginated on the local system and were processed on a remote system.Because this number is a longword, the buffer length field in the itemdescriptor should specify 4 (bytes). RMI$_BLKASTReturns the number of blocking ASTs.Because this number is a longword, the buffer length field in the itemdescriptor should specify 4 (bytes). RMI$_BUFIOReturns the number of buffered I/Os.Because this number is a longword, the buffer length field in the itemdescriptor should specify 4 (bytes). RMI$_BUFOBJPAGReturns the number of buffer object physical pages currently allocated.Because this number is a longword, the buffer length field in the itemdescriptor should specify 4 (bytes). RMI$_BUFOBJPAGPEAKReturns the maximum number of buffer object physical pages currentlyallocated.Because this number is a longword, the buffer length field in the itemdescriptor should specify 4 (bytes). RMI$_BUFOBJPAGS01Returns the number of buffer object pages currently allocated in S0 andS1 space.Because this number is a longword, the buffer length field in the itemdescriptor should specify 4 (bytes). RMI$_BUFOBJPAGS2Returns the number of buffer object physical pages currently allocatedin S2 space.Because this number is a longword, the buffer length field in the itemdescriptor should specify 4 (bytes). RMI$_BUFOBJPAGMAXS01Returns the available number of buffer object pages in S0 and S1 space.Because this number is a longword, the buffer length field in the itemdescriptor should specify 4 (bytes). RMI$_BUFOBJPAGMAXS2Returns the available number of buffer object pages in S2 space.Because this number is a longword, the buffer length field in the itemdescriptor should specify 4 (bytes). RMI$_BUFOBJPAGPEAKS01Returns the maximum number of buffer object pages currently allocatedin S0 and S1 space.Because this number is a longword, the buffer length field in the itemdescriptor should specify 4 (bytes). RMI$_BUFOBJPAGPEAKS2Returns the maximum number of buffer object pages currently allocatedin S2 space.Because this number is a longword, the buffer length field in the itemdescriptor should specify 4 (bytes). RMI$_BUFOBJPGLTMAXS01Returns the available number of buffer object pagelets in S0 and S1space.Because this number is a longword, the buffer length field in the itemdescriptor should specify 4 (bytes). RMI$_BUFOBJPGLTMAXS2Returns the available number of buffer object pagelets in S2 space.Because this number is a longword, the buffer length field in the itemdescriptor should specify 4 (bytes). RMI$_CEFReturns the number of processes in the common event flag wait state.Because this number is a longword, the buffer length field in the itemdescriptor should specify 4 (bytes). RMI$_COLPGReturns the number of processes in the collided page wait state.Because this number is a longword, the buffer length field in the itemdescriptor should specify 4 (bytes). RMI$_COMReturns the number of processes in the computable state.Because this number is a longword, the buffer length field in the itemdescriptor should specify 4 (bytes). RMI$_COMOReturns the number of outswapped processes in the computable state.Because this number is a longword, the buffer length field in the itemdescriptor should specify 4 (bytes). RMI$_CPUEXECReturns the amount of time, in 10-millisecond units, spent by all CPUsin executive mode.Because this number is a quadword, the buffer length field in the itemdescriptor should specify 8 (bytes). RMI$_CPUIDReturns the primary CPU ID.Because this number is a longword, the buffer length field in the itemdescriptor should specify 4 (bytes). RMI$_CPUIDLEReturns the amount of time, in 10-millisecond units, spent by all CPUsin idle mode.Because this number is a quadword, the buffer length field in the itemdescriptor should specify 8 (bytes). RMI$_CPUINTSTKReturns the amount of time, in 10-millisecond units, spent by all CPUsin processing interrupts.Because this number is a quadword, the buffer length field in the itemdescriptor should specify 8 (bytes). RMI$_CPUKERNELReturns the amount of time, in 10-millisecond units, spent by all CPUsin kernel mode.Because this number is a quadword, the buffer length field in the itemdescriptor should specify 8 (bytes). RMI$_CPUMPSYNCHReturns the amount of time, in 10-millisecond units, spent by theprimary CPU in synchronization mode.Because this number is a quadword, the buffer length field in the itemdescriptor should specify 8 (bytes). RMI$_CPUSUPERReturns the amount of time, in 10-millisecond units, spent by all CPUsin supervisor mode.Because this number is a quadword, the buffer length field in the itemdescriptor should specify 8 (bytes). RMI$_CPUUSERReturns the amount of time, in 10-millisecond units, spent by all CPUsin user mode.Because this number is a quadword, the buffer length field in the itemdescriptor should specify 8 (bytes). RMI$_CURReturns the number of currently-executing processes.Because this number is a longword, the buffer length field in the itemdescriptor should specify 4 (bytes). RMI$_CWPSBYTESINReturns the number of clusterwide process services (CWPS) message bytesreceived by the system.Because this number is a longword, the buffer length field in the itemdescriptor should specify 4 (bytes). RMI$_CWPSBYTESOUTReturns the number of CWPS message bytes sent by the system.Because this number is a longword, the buffer length field in the itemdescriptor should specify 4 (bytes). RMI$_CWPSJPISINReturns the number of CWPS $GETJPI requests received by the system.Because this number is a longword, the buffer length field in the itemdescriptor should specify 4 (bytes). RMI$_CWPSJPISOUTReturns the number of CWPS $GETJPI requests sent by the system.Because this number is a longword, the buffer length field in the itemdescriptor should specify 4 (bytes). RMI$_CWPSMSGSINReturns the number of CWPS messages received by the system.Because this number is a longword, the buffer length field in the itemdescriptor should specify 4 (bytes). RMI$_CWPSMSGSOUTReturns the number of CWPS messages sent by the system.Because this number is a longword, the buffer length field in the itemdescriptor should specify 4 (bytes). RMI$_CWPSPCNTRLINReturns the number of CWPS PCNTRL requests received by the system.Because this number is a longword, the buffer length field in the itemdescriptor should specify 4 (bytes). RMI$_CWPSPCNTRLOUTReturns the number of CWPS PCNTRL requests sent by the system.Because this number is a longword, the buffer length field in the itemdescriptor should specify 4 (bytes). RMI$_CWPSRSRCINReturns the number of CWPS resource-fail messages received by thesystem.Because this number is a longword, the buffer length field in the itemdescriptor should specify 4 (bytes). RMI$_CWPSRSRCOUTReturns the number of CWPS resource-fail messages sent by the system.Because this number is a longword, the buffer length field in the itemdescriptor should specify 4 (bytes). RMI$_DDTM_ABORTSReturns the accumulated systemwide count of transactions aborted(planned and unplanned).Because this number is a longword, the buffer length field in the itemdescriptor should specify 4 (bytes). RMI$_DDTM_ADDSReturns the accumulated systemwide count of transaction branches addedon the local node.Because this number is a longword, the buffer length field in the itemdescriptor should specify 4 (bytes). RMI$_DDTM_BAD_LINKSReturns the total number of bad message links received.Because this number is a longword, the buffer length field in the itemdescriptor should specify 4 (bytes). RMI$_DDTM_BAD_PARTSReturns the number of invalid part IDs found.Because this number is a longword, the buffer length field in the itemdescriptor should specify 4 (bytes). RMI$_DDTM_BAD_TYPECODEReturns the total number of bad message type codes received.Because this number is a longword, the buffer length field in the itemdescriptor should specify 4 (bytes). RMI$_DDTM_BRANCHSReturns the accumulated systemwide count of transaction branchesstarted on the local node.Because this number is a longword, the buffer length field in the itemdescriptor should specify 4 (bytes). RMI$_DDTM_BUCKETS1Returns the accumulated systemwide count of transactions with aduration of less than 1 second.Because this number is a longword, the buffer length field in the itemdescriptor should specify 4 (bytes). RMI$_DDTM_BUCKETS2Returns the accumulated systemwide count of transactions with aduration of 1 to 2 (1.99) seconds.Because this number is a longword, the buffer length field in the itemdescriptor should specify 4 (bytes). RMI$_DDTM_BUCKETS3Returns the accumulated systemwide count of transactions with aduration of 2 to 3 (2.99) seconds.Because this number is a longword, the buffer length field in the itemdescriptor should specify 4 (bytes). RMI$_DDTM_BUCKETS4Returns the accumulated systemwide count of transactions with aduration of 3 to 4 (3.99) seconds.Because this number is a longword, the buffer length field in the itemdescriptor should specify 4 (bytes). RMI$_DDTM_BUCKETS5Returns the accumulated systemwide count of transactions with aduration of 4 to 5 (4.99) seconds.Because this number is a longword, the buffer length field in the itemdescriptor should specify 4 (bytes). RMI$_DDTM_BUCKETS6Returns the accumulated systemwide count of transactions with aduration of at least 5 seconds.Because this number is a longword, the buffer length field in the itemdescriptor should specify 4 (bytes). RMI$_DDTM_DECLARESReturns the total number of $DECLARE_RMs.Because this number is a longword, the buffer length field in the itemdescriptor should specify 4 (bytes). RMI$_DDTM_DISC_COMPReturns the number of disconnected complete events.Because this number is a longword, the buffer length field in the itemdescriptor should specify 4 (bytes). RMI$_DDTM_ENDSReturns the accumulated systemwide count of transactions ended.Because this number is a longword, the buffer length field in the itemdescriptor should specify 4 (bytes). RMI$_DDTM_FOR_UNLINKSReturns the number of forced unlinks.Because this number is a longword, the buffer length field in the itemdescriptor should specify 4 (bytes). RMI$_DDTM_FORGETSReturns the total number of $FORGET_RMs.Because this number is a longword, the buffer length field in the itemdescriptor should specify 4 (bytes). RMI$_DDTM_JOINSReturns the total number of $JOIN_RMs.Because this number is a longword, the buffer length field in the itemdescriptor should specify 4 (bytes). RMI$_DDTM_LOG_COMMITSReturns the total number of commit records written.Because this number is a longword, the buffer length field in the itemdescriptor should specify 4 (bytes). RMI$_DDTM_LOG_FORGETSReturns the total number of forget records written.Because this number is a longword, the buffer length field in the itemdescriptor should specify 4 (bytes). RMI$_DDTM_LOG_PREPARESReturns the total number of prepare records written.Because this number is a longword, the buffer length field in the itemdescriptor should specify 4 (bytes). RMI$_DDTM_ONE_PHASEReturns the accumulated systemwide count of 1-phase commit eventsinitiated.Because this number is a longword, the buffer length field in the itemdescriptor should specify 4 (bytes). RMI$_DDTM_PREPARESReturns the accumulated systemwide count of transactions that have beenprepared.Because this number is a longword, the buffer length field in the itemdescriptor should specify 4 (bytes). RMI$_DDTM_SEQNOReturns the total number of XCBs created.Because this number is a longword, the buffer length field in the itemdescriptor should specify 4 (bytes). RMI$_DDTM_STARTSReturns the accumulated systemwide count of transactions successfullystarted.Because this number is a longword, the buffer length field in the itemdescriptor should specify 4 (bytes). RMI$_DDTM_TWOPHASE_ACKRCVReturns the accumulated systemwide count of 2-phase commit ACK messagesreceived.Because this number is a longword, the buffer length field in the itemdescriptor should specify 4 (bytes). RMI$_DDTM_TWOPHASE_ACKSNTReturns the accumulated systemwide count of 2-phase commit ACK messagessent.Because this number is a longword, the buffer length field in the itemdescriptor should specify 4 (bytes). RMI$_DDTM_TWOPHASE_CANRCVReturns the accumulated systemwide count of 2-phase commit cancelmessages received.Because this number is a longword, the buffer length field in the itemdescriptor should specify 4 (bytes). RMI$_DDTM_TWOPHASE_CANSNTReturns the accumulated systemwide count of 2-phase commit cancelmessages sent.Because this number is a longword, the buffer length field in the itemdescriptor should specify 4 (bytes). RMI$_DDTM_TWOPHASE_COMMITSReturns the accumulated systemwide count of 2-phase commit eventsinitiated.Because this number is a longword, the buffer length field in the itemdescriptor should specify 4 (bytes). RMI$_DDTM_TWOPHASE_RDYRCVReturns the accumulated systemwide count of 2-phase commit readymessages received.Because this number is a longword, the buffer length field in the itemdescriptor should specify 4 (bytes). RMI$_DDTM_TWOPHASE_RDYSNTReturns the accumulated systemwide count of 2-phase commit readymessages sent.Because this number is a longword, the buffer length field in the itemdescriptor should specify 4 (bytes). RMI$_DDTM_TWOPHASE_REQRCVReturns the accumulated systemwide count of 2-phase commit requestsreceived.Because this number is a longword, the buffer length field in the itemdescriptor should specify 4 (bytes). RMI$_DDTM_TWOPHASE_REQSNTReturns the accumulated systemwide count of 2-phase commit requestssent.Because this number is a longword, the buffer length field in the itemdescriptor should specify 4 (bytes). RMI$_DDTM_VOL_UNLINKSReturns the number of voluntary unlinks.Because this number is a longword, the buffer length field in the itemdescriptor should specify 4 (bytes). RMI$_DDTM_WRITES_FORKEDReturns the total number of forked writes.Because this number is a longword, the buffer length field in the itemdescriptor should specify 4 (bytes). RMI$_DDTM_WRITES_STARTEDReturns the total number of writes started.Because this number is a longword, the buffer length field in the itemdescriptor should specify 4 (bytes). RMI$_DEPLOCPKReturns the accumulated systemwide count of departing local DECnetpackets.Because this number is a longword, the buffer length field in the itemdescriptor should specify 4 (bytes). RMI$_DEQReturns the number of DEQ operations.Because this number is a longword, the buffer length field in the itemdescriptor should specify 4 (bytes). RMI$_DEQINReturns the accumulated systemwide count of unlock (dequeue) lockrequests that originated on a remote system and were processed on thelocal system.Because this number is a longword, the buffer length field in the itemdescriptor should specify 4 (bytes). RMI$_DEQLOCReturns the accumulated systemwide count of unlock (dequeue) requeststhat originated and were processed on the local system.Because this number is a longword, the buffer length field in the itemdescriptor should specify 4 (bytes). RMI$_DEQOUTReturns the accumulated systemwide count of unlock (dequeue) requeststhat originated on the local system and were processed on a remotesystem.Because this number is a longword, the buffer length field in the itemdescriptor should specify 4 (bytes). RMI$_DIRDATA_HITReturns the systemwide count of directory data cache hits.Because this number is a longword, the buffer length field in the itemdescriptor should specify 4 (bytes). RMI$_DIRDATA_MISSReturns the systemwide count of directory data cache misses.Because this number is a longword, the buffer length field in the itemdescriptor should specify 4 (bytes). RMI$_DIRFCB_HITReturns the systemwide count of directory FCB cache hits.Because this number is a longword, the buffer length field in the itemdescriptor should specify 4 (bytes). RMI$_DIRFCB_MISSReturns the systemwide count of directory FCB cache misses.Because this number is a longword, the buffer length field in the itemdescriptor should specify 4 (bytes). RMI$_DIRINReturns the accumulated systemwide count of directory operationsserviced by the local system that originated on remote systems.Because this number is a longword, the buffer length field in the itemdescriptor should specify 4 (bytes). RMI$_DIROUTReturns the accumulated systemwide count of directory operations thatoriginated on the local system and were serviced by remote systems.Because this number is a longword, the buffer length field in the itemdescriptor should specify 4 (bytes). RMI$_DIRIOReturns the number of direct I/Os.Because this number is a longword, the buffer length field in the itemdescriptor should specify 4 (bytes). RMI$_DLCK_INCMPLTReturns the accumulated systemwide count of incomplete deadlocksearches.Because this number is a longword, the buffer length field in the itemdescriptor should specify 4 (bytes). RMI$_DLCKFNDReturns the number of deadlocks found.Because this number is a longword, the buffer length field in the itemdescriptor should specify 4 (bytes). RMI$_DLCKMSGS_INReturns the systemwide count of incoming deadlock detection messages.Because this number is a longword, the buffer length field in the itemdescriptor should specify 4 (bytes). RMI$_DLCKMSGS_OUTReturns the accumulated systemwide count of outgoing deadlock detectionmessages.Because this number is a longword, the buffer length field in the itemdescriptor should specify 4 (bytes). RMI$_DLCKSRCHReturns the number of deadlock searches.Because this number is a longword, the buffer length field in the itemdescriptor should specify 4 (bytes). RMI$_DZROFLTSReturns the number of demand zero page faults.Because this number is a longword, the buffer length field in the itemdescriptor should specify 4 (bytes). RMI$_ENQCVTReturns the number of ENQ conversion operations.Because this number is a longword, the buffer length field in the itemdescriptor should specify 4 (bytes). RMI$_ENQCVTINReturns the accumulated systemwide count of lock conversion requeststhat originated on a remote system and were processed on the localsystem.Because this number is a longword, the buffer length field in the itemdescriptor should specify 4 (bytes). RMI$_ENQCVTLOCReturns the accumulated systemwide count of lock conversion requeststhat originated and were processed on the local system.Because this number is a longword, the buffer length field in the itemdescriptor should specify 4 (bytes). RMI$_ENQCVTOUTReturns the accumulated systemwide count of lock conversion requeststhat originated on the local system and were processed on a remotesystem.Because this number is a longword, the buffer length field in the itemdescriptor should specify 4 (bytes). RMI$_ENQNEWReturns the number of new ENQ operations.Because this number is a longword, the buffer length field in the itemdescriptor should specify 4 (bytes). RMI$_ENQNEWINReturns the accumulated systemwide count of new lock requests thatoriginated on a remote system and were processed on the local system.Because this number is a longword, the buffer length field in the itemdescriptor should specify 4 (bytes). RMI$_ENQNEWLOCReturns the accumulated systemwide count of new lock requests thatoriginated and were processed on the local system.Because this number is a longword, the buffer length field in the itemdescriptor should specify 4 (bytes). RMI$_ENQNEWOUTReturns the accumulated systemwide count of new lock requests thatoriginated on the local system and were processed on a remote system.Because this number is a longword, the buffer length field in the itemdescriptor should specify 4 (bytes). RMI$_ENQNOTQDReturns the number of ENQ operations not queued.Because this number is a longword, the buffer length field in the itemdescriptor should specify 4 (bytes). RMI$_ENQWAITReturns the number of ENQ operations forced to wait.Because this number is a longword, the buffer length field in the itemdescriptor should specify 4 (bytes). RMI$_EXEFAULTSReturns the number of execute page faults.Because this number is a longword, the buffer length field in the itemdescriptor should specify 4 (bytes). RMI$_EXTHITReturns the systemwide count of extent cache hits.Because this number is a longword, the buffer length field in the itemdescriptor should specify 4 (bytes). RMI$_EXTMISSReturns the systemwide count of extent cache misses.Because this number is a longword, the buffer length field in the itemdescriptor should specify 4 (bytes). RMI$_FAULTSReturns the number of page faults since last system initialization.Because this number is a longword, the buffer length field in the itemdescriptor should specify 4 (bytes). RMI$_FCPCACHEReturns the total number of cache hits by the FCP.Because this number is a longword, the buffer length field in the itemdescriptor should specify 4 (bytes). RMI$_FCPCALLSReturns the total number of calls to the FCP.Because this number is a longword, the buffer length field in the itemdescriptor should specify 4 (bytes). RMI$_FCPCPUReturns the total number of CPU tics used by the FCP.Because this number is a longword, the buffer length field in the itemdescriptor should specify 4 (bytes). RMI$_FCPCREATEReturns the number of new files created since the system was booted.Because this number is a longword, the buffer length field in the itemdescriptor should specify 4 (bytes). RMI$_FCPERASEReturns the number of erase I/O operations issued.Because this number is a longword, the buffer length field in the itemdescriptor should specify 4 (bytes). RMI$_FCPFAULTReturns the number of FCP page faults.Because this number is a longword, the buffer length field in the itemdescriptor should specify 4 (bytes). RMI$_FCPHITReturns the total number of file I/O transfers for which no disk accesswas required.Because this number is a longword, the buffer length field in the itemdescriptor should specify 4 (bytes). RMI$_FCPREADReturns the total number of disk reads by the FCP.Because this number is a longword, the buffer length field in the itemdescriptor should specify 4 (bytes). RMI$_FCPSPLITReturns the number of split transfers performed by the FCP.Because this number is a longword, the buffer length field in the itemdescriptor should specify 4 (bytes). RMI$_FCPTURNReturns the number of file-map window misses.Because this number is a longword, the buffer length field in the itemdescriptor should specify 4 (bytes). RMI$_FCPWRITEReturns the total number of disk writes by the FCP.Because this number is a longword, the buffer length field in the itemdescriptor should specify 4 (bytes). RMI$_FIDHITReturns the systemwide count of File ID cache hits.Because this number is a longword, the buffer length field in the itemdescriptor should specify 4 (bytes). RMI$_FIDMISSReturns the systemwide count of File ID cache misses.Because this number is a longword, the buffer length field in the itemdescriptor should specify 4 (bytes). RMI$_FILHDR_HITReturns the systemwide count of file header cache hits.Because this number is a longword, the buffer length field in the itemdescriptor should specify 4 (bytes). RMI$_FILHDR_MISSReturns the systemwide count of file header cache misses.Because this number is a longword, the buffer length field in the itemdescriptor should specify 4 (bytes). RMI$_FPGReturns the number of processes in the free page wait state.Because this number is a longword, the buffer length field in the itemdescriptor should specify 4 (bytes). RMI$_FREFLTSReturns the number of page faults from the free list.Because this number is a longword, the buffer length field in the itemdescriptor should specify 4 (bytes). RMI$_FRLISTReturns the number of pages on the free list.Because this number is a longword, the buffer length field in the itemdescriptor should specify 4 (bytes). RMI$_GBP_CURMAP - Alpha OnlyReturns the count of global pages currently mapped.Because this number is a longword, the buffer length field in the itemdescriptor should specify 4 (bytes). RMI$_GBP_CURMAP_GRP - Alpha OnlyReturns the count of group global pages currently mapped.Because this number is a longword, the buffer length field in the itemdescriptor should specify 4 (bytes). RMI$_GBP_CURMAP_GRPWRT - Alpha OnlyReturns the count of writable group global pages currently mapped.Because this number is a longword, the buffer length field in the itemdescriptor should specify 4 (bytes). RMI$_GBP_CURMAP_SYS - Alpha OnlyReturns the count of system global pages currently mapped.Because this number is a longword, the buffer length field in the itemdescriptor should specify 4 (bytes). RMI$_GBP_CURMAP_SYSWRT - Alpha OnlyReturns the count of writable system global pages currently mapped.Because this number is a longword, the buffer length field in the itemdescriptor should specify 4 (bytes). RMI$_GBP_MAXMAP - Alpha OnlyReturns the maximum count of global pages simultaneously mapped.Because this number is a longword, the buffer length field in the itemdescriptor should specify 4 (bytes). RMI$_GBS_CURMAP - Alpha OnlyReturns the count of global sections currently mapped.Because this number is a longword, the buffer length field in the itemdescriptor should specify 4 (bytes). RMI$_GBS_CURMAP_GRP - Alpha OnlyReturns the count of group global sections currently mapped.Because this number is a longword, the buffer length field in the itemdescriptor should specify 4 (bytes). RMI$_GBS_CURMAP_GRPWRT - Alpha OnlyReturns the count of writable group global sections currently mapped.Because this number is a longword, the buffer length field in the itemdescriptor should specify 4 (bytes). RMI$_GBS_CURMAP_SYS - Alpha OnlyReturns the count of system global sections currently mapped.Because this number is a longword, the buffer length field in the itemdescriptor should specify 4 (bytes). RMI$_GBS_CURMAP_SYSWRT - Alpha OnlyReturns the count of writable system global sections currently mapped.Because this number is a longword, the buffer length field in the itemdescriptor should specify 4 (bytes). RMI$_GBS_MAXMAP - Alpha OnlyReturns the maximum count of global sections simultaneously mapped.Because this number is a longword, the buffer length field in the itemdescriptor should specify 4 (bytes). RMI$_GBS_NOREF - Alpha OnlyReturns the current count of global sections not mapped to a process(reference count is 0).Because this number is a longword, the buffer length field in the itemdescriptor should specify 4 (bytes). RMI$_GVALFLTSReturns the number of global valid page faults.Because this number is a longword the buffer length field in the itemdescriptor should specify 4 (bytes). RMI$_HDRINSWAPSReturns the accumulated systemwide count of process header inswapoperations.Because this number is a longword, the buffer length field in the itemdescriptor should specify 4 (bytes). RMI$_HDROUTSWAPSReturns the accumulated systemwide count of process header outswapoperations.Because this number is a longword, the buffer length field in the itemdescriptor should specify 4 (bytes). RMI$_HIBReturns the number of processes in the hibernate state.Because this number is a longword, the buffer length field in the itemdescriptor should specify 4 (bytes). RMI$_HIBOReturns the number of outswapped processes in the hibernate state.Because this number is a longword, the buffer length field in the itemdescriptor should specify 4 (bytes). RMI$_IOPAGCNTReturns the systemwide count of pages in transit to disk from themodified page list.Because this number is a longword, the buffer length field in the itemdescriptor should specify 4 (bytes). RMI$_ISWPCNTReturns the number of process inswaps.Because this number is a longword, the buffer length field in the itemdescriptor should specify 4 (bytes). RMI$_ISWPCNTPGReturns the accumulated systemwide count of pages inswapped.Because this number is a longword, the buffer length field in the itemdescriptor should specify 4 (bytes). RMI$_LCKMGR_CPUReturns the ID of the CPU on which the lock manager process runs.Because this number is a longword, the buffer length field in the itemdescriptor should specify 4 (bytes). RMI$_LCKMGR_PIDReturns the PID of the lock manager process.Because this number is a longword, the buffer length field in the itemdescriptor should specify 4 (bytes). RMI$_LCKMGR_REQCNTReturns the accumulated count of requests handled by the lock manager.Because this number is a quadword, the buffer length field in the itemdescriptor should specify 8 (bytes). RMI$_LCKMGR_REQTIMEReturns the accumulated time spent by the lock manager servicingrequests.Because this number is a quadword, the buffer length field in the itemdescriptor should specify 8 (bytes). RMI$_LCKMGR_SPINCNTReturns the accumulated count of times the lock manager entered a spinloop.Because this number is a quadword, the buffer length field in the itemdescriptor should specify 8 (bytes). RMI$_LCKMGR_SPINTIMEReturns the accumulated spin time, in cycles, of the lock manager.Because this number is a quadword, the buffer length field in the itemdescriptor should specify 8 (bytes). RMI$_LEFReturns the number of processes in the local event flag wait state.Because this number is a longword, the buffer length field in the itemdescriptor should specify 4 (bytes). RMI$_LEFOReturns the number of outswapped processes in the local event flag waitstate.Because this number is a longword, the buffer length field in the itemdescriptor should specify 4 (bytes). RMI$_LOCK_MAXReturns the lock ID table length.Because this number is a longword, the buffer length field in the itemdescriptor should specify 4 (bytes). RMI$_LOGNAMReturns the number of logical name translations.Because this number is a longword, the buffer length field in the itemdescriptor should specify 4 (bytes). RMI$_LPZ_ALLOC2Returns the number of allocations from other than the first page of thelock manager's pool zone.Because this number is a longword, the buffer length field in the itemdescriptor should specify 4 (bytes). RMI$_LPZ_ALLOCFReturns the number of failed allocations from the lock manager's poolzone.Because this number is a longword, the buffer length field in the itemdescriptor should specify 4 (bytes). RMI$_LPZ_EMPTYReturns the number of empty pages in the lock manager's pool zone.Because this number is a longword, the buffer length field in the itemdescriptor should specify 4 (bytes). RMI$_LPZ_EXPCNTReturns the accumulated number of expansions of the lock manager's poolzone.Because this number is a longword, the buffer length field in the itemdescriptor should specify 4 (bytes). RMI$_LPZ_HITSReturns the number of hits for the lock manager's pool zone.Because this number is a longword, the buffer length field in the itemdescriptor should specify 4 (bytes). RMI$_LPZ_MAXPAGReturns the maximum number of pages in the lock manager's pool zone.Because this number is a longword, the buffer length field in the itemdescriptor should specify 4 (bytes). RMI$_LPZ_MISSESReturns the number of misses for the lock manager's pool zone.Because this number is a longword, the buffer length field in the itemdescriptor should specify 4 (bytes). RMI$_LPZ_PAGCNTReturns the number of pages currently in the lock manager's pool zone.Because this number is a longword, the buffer length field in the itemdescriptor should specify 4 (bytes). RMI$_LPZ_PAKSIZReturns the packet size for the lock manager's pool zone.Because this number is a longword, the buffer length field in the itemdescriptor should specify 4 (bytes). RMI$_MBREADSReturns the number of mailbox reads.Because this number is a longword, the buffer length field in the itemdescriptor should specify 4 (bytes). RMI$_MBWRITESReturns the number of mailbox writes.Because this number is a longword, the buffer length field in the itemdescriptor should specify 4 (bytes). RMI$_MCHKERRSReturns the accumulated count of machine checks since the system wasbooted.Because this number is a longword, the buffer length field in the itemdescriptor should specify 4 (bytes). RMI$_MEMERRSReturns the accumulated count of memory errors since the system wasbooted.Because this number is a longword, the buffer length field in the itemdescriptor should specify 4 (bytes). RMI$_MODLISTReturns the number of pages on the modified page list.Because this number is a longword, the buffer length field in the itemdescriptor should specify 4 (bytes). RMI$_MSCP_EVERYTHINGReturns all the performance data items in the following order: | MSCP_BUFAVL | Current number of free MSCP buffers | | MSCP_BUFSMALL | Smallest MSCP buffer size allowed | | MSCP_BUFWAITCUR | Number of requests currently queued waiting for MSCP buffer memory | | MSCP_BUFWAITPEAK | Maximum number of requests simultaneously queued waiting for MSCP buffer | | MSCP_DSKSRV | Number of MSCP served disks | | MSCP_HSTSRV | Number of MSCP served hosts | | MSCP_LB_FAILCNT | MSCP server's count of failed load-balancing requests | | MSCP_LB_INITCNT | MSCP server's count of load-balancing requests sent | | MSCP_LB_LMLOAD1 | MSCP server's previous interval's load 1 value | | MSCP_LB_LMLOAD2 | MSCP server's previous interval's load 2 value | | MSCP_LB_LMLOAD3 | MSCP server's previous interval's load 3 value | | MSCP_LB_LMLOAD4 | MSCP server's previous interval's load 4 value | | MSCP_LB_LOAD | MSCP server's target load for load-balancing requests | | MSCP_LB_LOAD_AVAIL | MSCP server's current load available value | | MSCP_LB_LOAD_CAP | MSCP server's load capacity value | | MSCP_LB_MONINT | MSCP server's load-monitoring interval size | | MSCP_LB_MONTIME | The time that the last load-balancing monitor pass was made | | MSCP_LB_REQCNT | MSCP server's count of load-balancing requests received from other servers | | MSCP_LB_REQTIME | The time that the last load-balancing request was sent | | MSCP_LB_RESPCNT | MSCP server's count of load-balancing requests to which it responded | | MSCP_LB_RESP | MSCP server's load available from another server | | MSCP_OPCOUNT | Count of I/O transfer requests by remote processors | | MSCP_VCFAIL | Count of virtual cache failures on MSCP-served requests | | MSCP_READ | Count of Read I/O transfer requests by remote processors | | MSCP_WRITE | Count of Write I/O transfer requests by remote processors | | MSCP_FRAGMENT | Count of extra fragments issued by the MSCP server | | MSCP_SPLITXFER | Count of fragmented requests issued by the MSCP server | | MSCP_BUFWAIT | Count of requests that had to wait for MSCP buffer memory | | MSCP_SIZE1 | Count of MSCP-served I/O requests with a length of 1 block | | MSCP_SIZE2 | Count of MSCP-served I/O requests with a length of 2-3 blocks | | MSCP_SIZE3 | Count of MSCP-served I/O requests with a length of 4-7 blocks | | MSCP_SIZE4 | Count of MSCP-served I/O requests with a length of 8-15 blocks | | MSCP_SIZE5 | Count of MSCP-served I/O requests with a length of 16-31 blocks | | MSCP_SIZE6 | Count of MSCP-served I/O requests with a length of 32-63 blocks | | MSCP_SIZE7 | Count of MSCP-served I/O requests with a length of 64 or more blocks | Because this an array of 35 longwords, the buffer length field in theitem descriptor should specify 4 times 35 (bytes). RMI$_MWAITReturns the number of processes in the miscellaneous resource waitstate.Because this number is a longword, the buffer length field in the itemdescriptor should specify 4 (bytes). RMI$_NP_POOL_ALLOCReturns the accumulated count of nonpaged pool allocation requests.Because this number is a longword, the buffer length field in the itemdescriptor should specify 4 (bytes). RMI$_NP_POOL_ALLOCFReturns the accumulated count of unsuccessful nonpaged pool allocationrequests.Because this number is a longword, the buffer length field in the itemdescriptor should specify 4 (bytes). RMI$_NP_POOL_EXPReturns the accumulated count of successful expansions of nonpaged pool.Because this number is a longword, the buffer length field in the itemdescriptor should specify 4 (bytes). RMI$_NP_POOL_EXPFReturns the accumulated count of unsuccessful attempts to expandnonpaged pool.Because this number is a longword, the buffer length field in the itemdescriptor should specify 4 (bytes). RMI$_NUMLOCKSReturns the total number of locks.Because this number is a longword, the buffer length field in the itemdescriptor should specify 4 (bytes). RMI$_NUMRESReturns the total number of resources.Because this number is a longword, the buffer length field in the itemdescriptor should specify 4 (bytes). RMI$_OPENSReturns the systemwide count of files opened.Because this number is a longword, the buffer length field in the itemdescriptor should specify 4 (bytes). RMI$_OSWPCNTReturns the accumulated systemwide count of process outswap operations.Because this number is a longword, the buffer length field in the itemdescriptor should specify 4 (bytes). RMI$_OSWPCNTPGReturns the accumulated systemwide count of pages outswapped.Because this number is a longword, the buffer length field in the itemdescriptor should specify 4 (bytes). RMI$_PFWReturns the number of processes in the page fault wait state.Because this number is a longword, the buffer length field in the itemdescriptor should specify 4 (bytes). RMI$_PG_POOL_ALLOCReturns the accumulated count of paged pool allocation requests.Because this number is a longword, the buffer length field in the itemdescriptor should specify 4 (bytes). RMI$_PG_POOL_ALLOCFReturns the accumulated count of unsuccessful paged pool allocationrequests.Because this number is a longword, the buffer length field in the itemdescriptor should specify 4 (bytes). RMI$_PG_POOL_EXPFReturns the accumulated count of paged pool failures.Because this number is a longword, the buffer length field in the itemdescriptor should specify 4 (bytes). RMI$_PREADIOReturns physical page read I/Os.Because this number is a longword, the buffer length field in the itemdescriptor should specify 4 (bytes). RMI$_PREADSReturns the number of pages read.Because this number is a longword, the buffer length field in the itemdescriptor should specify 4 (bytes). RMI$_PROCBALSETCNTReturns the number of processes in the balance set.Because this number is a longword, the buffer length field in the itemdescriptor should specify 4 (bytes). RMI$_PROCBATCNTReturns the number of batch processes known to the system.Because this number is a longword, the buffer length field in the itemdescriptor should specify 4 (bytes). RMI$_PROCCNTMAXReturns the maximum number of concurrent processes seen by the system.Because this number is a longword, the buffer length field in the itemdescriptor should specify 4 (bytes). RMI$_PROCINTCNTReturns the number of interactive processes known to the system.Because this number is a longword, the buffer length field in the itemdescriptor should specify 4 (bytes). RMI$_PROCLOADCNTReturns the accumulated systemwide count of process context loadoperations.Because this number is a longword, the buffer length field in the itemdescriptor should specify 4 (bytes). RMI$_PROCNETCNTReturns the number of network processes known to the system.Because this number is a longword, the buffer length field in the itemdescriptor should specify 4 (bytes). RMI$_PROCSReturns the number of processes currently known to the system.Because this number is a longword, the buffer length field in the itemdescriptor should specify 4 (bytes). RMI$_PROCSWITCHCNTReturns the number of switches from the currently-executing process.Because this number is a longword, the buffer length field in the itemdescriptor should specify 4 (bytes). RMI$_PWRITESReturns the number of pages written.Because this number is a longword, the buffer length field in the itemdescriptor should specify 4 (bytes). RMI$_PWRITIOReturns physical page write I/Os.Because this number is a longword, the buffer length field in the itemdescriptor should specify 4 (bytes). RMI$_QUOHITReturns the systemwide count of quota cache hits.Because this number is a longword, the buffer length field in the itemdescriptor should specify 4 (bytes). RMI$_QUOMISSReturns the systemwide count of quota cache misses.Because this number is a longword, the buffer length field in the itemdescriptor should specify 4 (bytes). RMI$_RCVBUFFLReturns the accumulated systemwide count of DECnet receiver bufferfailures.Because this number is a longword, the buffer length field in the itemdescriptor should specify 4 (bytes). RMI$_RDFAULTSReturns the number of fault-on-read page faults.Because this number is a longword, the buffer length field in the itemdescriptor should specify 4 (bytes). RMI$_RML_ACQUIREReturns the accumulated systemwide count of lock trees moved to thisnode.Because this number is a longword, the buffer length field in the itemdescriptor should specify 4 (bytes). RMI$_RML_BETTERReturns the accumulated systemwide count of lock trees moved from thisnode to a cluster node with a higher value for the system parameterLOCKDIRWT.Because this number is a longword, the buffer length field in the itemdescriptor should specify 4 (bytes). RMI$_RML_MORE_ACTReturns the accumulated systemwide count of lock trees moved from thisnode due to higher locking activity on another node in the cluster.Because this number is a longword, the buffer length field in the itemdescriptor should specify 4 (bytes). RMI$_RML_MSGRCVReturns the accumulated systemwide count of remaster messages receivedby this node.Because this number is a longword, the buffer length field in the itemdescriptor should specify 4 (bytes). RMI$_RML_MSGSENTReturns the accumulated systemwide count of remaster messages sent fromthis node.Because this number is a longword, the buffer length field in the itemdescriptor should specify 4 (bytes). RMI$_RML_NOQUOTAReturns the accumulated systemwide count of remaster operations thatfailed due to a lack of quota.Because this number is a longword, the buffer length field in the itemdescriptor should specify 4 (bytes). RMI$_RML_NOTAKERReturns the accumulated systemwide count of remaster operations thatwere proposed and declined.Because this number is a longword, the buffer length field in the itemdescriptor should specify 4 (bytes). RMI$_RML_OPCNTReturns the accumulated systemwide count of remaster operations thathave been completed.Because this number is a longword, the buffer length field in the itemdescriptor should specify 4 (bytes). RMI$_RML_RBLDMSGRCVReturns the accumulated systemwide count of remaster rebuild messagesreceived by this node.Because this number is a longword, the buffer length field in the itemdescriptor should specify 4 (bytes). RMI$_RML_RBLDMSGSENTReturns the accumulated systemwide count of remaster rebuild messagessent from this node.Because this number is a longword, the buffer length field in the itemdescriptor should specify 4 (bytes). RMI$_RML_SINGLEReturns the accumulated systemwide count of lock trees moved from thisnode to another cluster node because that node is the only one withlocks remaining on the tree.Because this number is a longword, the buffer length field in the itemdescriptor should specify 4 (bytes). RMI$_RML_UNLOADReturns the accumulated systemwide count of lock trees moved from thisnode.Because this number is a longword, the buffer length field in the itemdescriptor should specify 4 (bytes). RMI$_SMP_CURMAP - Alpha OnlyReturns the count of global pages currently mapped for Galaxy sharedmemory.Because this number is a longword, the buffer length field in the itemdescriptor should specify 4 (bytes). RMI$_SMP_CURMAP_GRP - Alpha OnlyReturns the count of group global pages currently mapped for Galaxyshared memory.Because this number is a longword, the buffer length field in the itemdescriptor should specify 4 (bytes). RMI$_SMP_CURMAP_GRPWRT - Alpha OnlyReturns the count of writable group global pages currently mapped forGalaxy shared memory.Because this number is a longword, the buffer length field in the itemdescriptor should specify 4 (bytes). RMI$_SMP_CURMAP_SYS - Alpha OnlyReturns the count of system global pages currently mapped for Galaxyshared memory.Because this number is a longword, the buffer length field in the itemdescriptor should specify 4 (bytes). RMI$_SMP_CURMAP_SYSWRT - Alpha OnlyReturns the count of writable system global pages currently mapped forGalaxy shared memory.Because this number is a longword, the buffer length field in the itemdescriptor should specify 4 (bytes). RMI$_SMS_CURMAP - Alpha OnlyReturns the count of global sections currently mapped for Galaxy sharedmemory.Because this number is a longword, the buffer length field in the itemdescriptor should specify 4 (bytes). RMI$_SMS_CURMAP_GRP - Alpha OnlyReturns the count of group global sections currently mapped for Galaxyshared memory.Because this number is a longword, the buffer length field in the itemdescriptor should specify 4 (bytes). RMI$_SMS_CURMAP_GRPWRT - Alpha OnlyReturns the count of writable group global sections currently mappedfor Galaxy shared memory.Because this number is a longword, the buffer length field in the itemdescriptor should specify 4 (bytes). RMI$_SMS_CURMAP_SYS - Alpha OnlyReturns the count of system global sections currently mapped for Galaxyshared memory.Because this number is a longword, the buffer length field in the itemdescriptor should specify 4 (bytes). RMI$_SMS_CURMAP_SYSWRT - Alpha OnlyReturns the count of writable system global sections currently mappedfor Galaxy shared memory.Because this number is a longword, the buffer length field in the itemdescriptor should specify 4 (bytes). RMI$_SMS_NOREF - Alpha OnlyReturns the current count of global sections for Galaxy shared memorythat are not mapped to a process (reference count is 0).Because this number is a longword, the buffer length field in the itemdescriptor should specify 4 (bytes). RMI$_STORAGMAP_HITReturns the systemwide count of storage bitmap cache hits.Because this number is a longword, the buffer length field in the itemdescriptor should specify 4 (bytes). RMI$_STORAGMAP_MISSReturns the systemwide count of storage bitmap cache misses.Because this number is a longword, the buffer length field in the itemdescriptor should specify 4 (bytes). RMI$_SUSPReturns the number of processes in the suspended state.Because this number is a longword, the buffer length field in the itemdescriptor should specify 4 (bytes). RMI$_SUSPOReturns the number of outswapped processes in the suspended state.Because this number is a longword, the buffer length field in the itemdescriptor should specify 4 (bytes). RMI$_SYNCHLCKReturns the systemwide count of directory- or file-synch locks.Because this number is a longword, the buffer length field in the itemdescriptor should specify 4 (bytes). RMI$_SYNCHWAITReturns the systemwide count of times the XQP waited for a directory-or file-synch lock.Because this number is a longword, the buffer length field in the itemdescriptor should specify 4 (bytes). RMI$_SYSFAULTSReturns the number of system page faults.Because this number is a longword, the buffer length field in the itemdescriptor should specify 4 (bytes). RMI$_TMSCP_EVERYTHINGReturns all the performance data items in the following order: | TMSCP_BUFWAIT | Count of requests that had to wait for TMSCP buffer memory | | TMSCP_HSTSRV | Number of TMSCP served hosts | | TMSCP_TAPSRV | Number of TMSCP served tapes | | TMSCP_OPCOUNT | Total operations count | | TMSCP_ABORTCNT | Total abort operations count | | TMSCP_BUFAVAIL | Free TMSCP pool bytes | | TMSCP_ONLINCNT | Count of online tapes | | TMSCP_ACCESSCNT | Total access count | | TMSCP_FLUSHCNT | Total flush count | | TMSCP_RDCOUNT | Count of read I/O requests by remote processors | | TMSCP_WRCOUNT | Count of write I/O requests by remote processors | | TMSCP_VCFAIL | Number of virtual cache failures on TMSCP served requests in location 23 | | TMSCP_FRAGMENT | Extra fragments | | TMSCP_SIZE1 | Count of TMSCP served I/O requests with a length of 1 block | | TMSCP_SIZE2 | Count of TMSCP served I/O requests with a length of 2-3 blocks | | TMSCP_SIZE3 | Count of TMSCP served I/O requests with a length of 4-7 blocks | | TMSCP_SIZE4 | Count of TMSCP served I/O requests with a length of 8-15 blocks | | TMSCP_SIZE5 | Count of TMSCP served I/O requests with a length of 16-31 blocks | | TMSCP_SIZE6 | Count of TMSCP served I/O requests with a length of 32-63 blocks | | TMSCP_SIZE7 | Count of TMSCP served I/O requests with a length of 64 or more blocks | Because this is an array of 20 longwords, the buffer length field inthe item descriptor should specify 4 times 20 (bytes). RMI$_TQESYSUBReturns the accumulated systemwide count of timer requests made by theOpenVMS operating system.Because this number is a quadword, the buffer length field in the itemdescriptor should specify 8 (bytes). RMI$_TQETOTALReturns the accumulated systemwide count of timer requests.Because this number is a quadword, the buffer length field in the itemdescriptor should specify 8 (bytes). RMI$_TQEUSRTIMRReturns the accumulated systemwide count of timer requests made byapplication programs through the SYS$SETIMR system service.Because this number is a quadword, the buffer length field in the itemdescriptor should specify 8 (bytes). RMI$_TQEUSRWAKEReturns the accumulated systemwide count of timer requests made byapplication programs through the SYS$SCHDWK system service.Because this number is a quadword, the buffer length field in the itemdescriptor should specify 8 (bytes). RMI$_TRANSFLTSReturns the accumulated systemwide count of transition (release pendingor read-in-progress) faults.Because this number is a longword, the buffer length field in the itemdescriptor should specify 4 (bytes). RMI$_TRCNGLOSReturns the accumulated systemwide count of DECnet packets lost due totransit congestion.Because this number is a longword, the buffer length field in the itemdescriptor should specify 4 (bytes). RMI$_TTREADCNTReturns the accumulated systemwide count of characters read fromterminals.Because this number is a longword, the buffer length field in the itemdescriptor should specify 4 (bytes). RMI$_TTREADSReturns the accumulated systemwide count of reads from terminals.Because this number is a longword, the buffer length field in the itemdescriptor should specify 4 (bytes). RMI$_TTWRITECNTReturns the accumulated systemwide count of characters written toterminals.Because this number is a longword, the buffer length field in the itemdescriptor should specify 4 (bytes). RMI$_TTWRITESReturns the accumulated systemwide count of writes to terminals.Because this number is a longword, the buffer length field in the itemdescriptor should specify 4 (bytes). RMI$_USERPAGESReturns the number of pages available for use by applications.Because this number is a longword, the buffer length field in the itemdescriptor should specify 4 (bytes). RMI$_VCPUTICKS - VAX OnlyReturns the accumulated systemwide count of virtual balance slot clockticks (10-millisecond units).Because this number is a longword, the buffer length field in the itemdescriptor should specify 4 (bytes). RMI$_VMSPAGESReturns the number of pages actually allocated to OpenVMS.Because this number is a longword, the buffer length field in the itemdescriptor should specify 4 (bytes). RMI$_VOLLCKReturns the accumulated systemwide count of volume-synch locks.Because this number is a longword, the buffer length field in the itemdescriptor should specify 4 (bytes). RMI$_VOLWAITReturns the number of times the XQP entered a wait state due to volumelock contention.Because this number is a longword, the buffer length field in the itemdescriptor should specify 4 (bytes). RMI$_VRBS_TRAN - VAX OnlyReturns the accumulated systemwide count of faults from virtual balanceslots to real balance slots.Because this number is a longword, the buffer length field in the itemdescriptor should specify 4 (bytes). RMI$_WRTFAULTSReturns the number of fault-on-write page faults.Because this number is a longword, the buffer length field in the itemdescriptor should specify 4 (bytes). RMI$_WRTINPROGReturns the number of page faults from a write in progress.Because this number is a longword, the buffer length field in the itemdescriptor should specify 4 (bytes). RMI$_XQPCACHEWAITReturns the systemwide count of times the XQP waited for free space ina cache.Because this number is a longword, the buffer length field in the itemdescriptor should specify 4 (bytes).
DescriptionThe Get Resource Monitor Information service returns performanceinformation about the local system.Required Access or Privileges
None. Required Quota
This service uses the process's AST limit quota (ASTLM). Related Services
None.
Condition Values Returned | SS$_NORMAL | The service completed successfully. | | SS$_ACCVIO | The caller cannot read the item list, cannot write to the buffer specified by the buffer address field in the item descriptor, or cannot write to the return length address field in an item descriptor. | | SS$_BADPARAM | The item list contains an invalid item code. | | SS$_EXASTLM | The process has exceeded its AST limit quota. |
$GETSYIReturns information about the local system or about other systems in anOpenVMS Cluster system. The $GETSYI service completes asynchronously;for synchronous completion, use the Get Systemwide Information and Wait($GETSYIW) service.For additional information about system service completion, refer tothe Synchronize ($SYNCH) service. On Alpha systems, this service accepts 64-bit addresses.
FormatSYS$GETSYI [efn] ,[csidadr] ,[nodename] ,itmlst [,iosb] [,astadr][,astprm]
C Prototypeint sys$getsyi (unsigned int efn, unsigned int *csidadr, void*nodename, void *itmlst, struct _iosb *iosb, void(*astadr)(__unknown_params), unsigned __int64 astprm);
Argumentsefn
| OpenVMS usage: | ef_number | | type: | longword (unsigned) | | access: | read only | | mechanism: | by value |
Number of the event flag to be set when the $GETSYI request completes.The efn argument is a longword containing this number;however, $GETSYI uses only the low-order byte.Upon request initiation, $GETSYI clears the specified event flag (orevent flag 0 if efn was not specified). Then, when therequest completes, the specified event flag (or event flag 0) is set. csidadr
| OpenVMS usage: | process_id | | type: | longword (unsigned) | | access: | modify | | mechanism: | by 32- or 64-bit reference (Alpha) | | mechanism: | by 32-bit reference (VAX) |
OpenVMS Cluster system identification of the node about which $GETSYIis to return information. The csidadr argument is the32-bit address (on VAX systems) or the 32- or 64-bit address (on Alphasystems) of a longword containing this identification value.The cluster-connection software assigns the OpenVMS Cluster systemidentification of a node. You can obtain this information by using theDCL command SHOW CLUSTER. The value of the cluster systemidentification for a node is not permanent; a new value is assigned toa node whenever it joins or rejoins the cluster. You can also specify a node to $GETSYI by using thenodename argument. If you specifycsidadr, you need not specifynodename, and vice versa. If you specify both, theymust identify the same node. If you specify neither argument, $GETSYIreturns information about the local node; however, for wildcardoperations, you must use the csidadr argument. If you specify csidadr as --1, $GETSYI assumes awildcard operation and returns the requested information for each nodein the cluster, one node per call. In this case, the program shouldtest for the condition value SS$_NOMORENODE after each call to $GETSYIand should stop calling $GETSYI when SS$_NOMORENODE is returned. nodename
| OpenVMS usage: | process_name | | type: | character-coded text string | | access: | read only | | mechanism: | by 32- or 64-bit descriptor--fixed-length string descriptor (Alpha) | | mechanism: | by 32-bit descriptor--fixed-length string descriptor (VAX) |
Name of the node about which $GETSYI is to return information. Thenodename argument is the 32-bit address (on VAXsystems) or the 32- or 64-bit address (on Alpha systems) of a characterstring descriptor pointing to this name string.The node name string must contain from 1 to 15 characters and mustcorrespond exactly to the node name; no trailing blanks orabbreviations are permitted. You can also specify a node to $GETSYI by using thecsidadr argument. See the description ofcsidadr. itmlst
| OpenVMS usage: | 32-bit item_list_3 or 64-bit item_list_64b | | type: | longword (unsigned) for 32-bit; quadword (unsigned) for 64-bit | | access: | read only | | mechanism: | by 32- or 64-bit reference (Alpha) | | mechanism: | by 32-bit reference (VAX) |
Item list specifying which information is to be returned about the nodeor nodes. The itmlst argument is the 32-bit address(on VAX systems) or the 32- or 64-bit address (on Alpha systems) of alist of item descriptors, each of which describes an item ofinformation. An item list in 32-bit format is terminated by a longwordof 0; an item list in 64-bit format is terminated by a quadword of 0.All items in an item list must be of the same format---either 32-bit or64-bit.The following diagram depicts the 32-bit format of a single itemdescriptor:
The following table defines the item descriptor fields for 32-bit itemlist entries: | Descriptor Field | Definition | | Buffer length | A word containing a user-supplied integer specifying the length (in bytes) of the buffer in which $GETSYI is to write the information. The length of the buffer needed depends on the item code specified in the item code field of the item descriptor. If the value of the buffer length field is too small, $GETSYI truncates the data. | | Item code | A word containing a user-supplied symbolic code specifying the item of information that $GETSYI is to return. The $SYIDEF macro defines these codes. A description of each item code is given in the Item Codes section. | | Buffer address | A longword containing the user-supplied 32-bit address of the buffer into which $GETSYI is to write the information. | | Return length address | A longword containing the user-supplied 32-bit address of a word in which $GETSYI writes the length in bytes of the information it actually returned. | The following diagram depicts the 64-bit format of a single itemdescriptor:
 The following table defines the item descriptor fields for 64-bit itemlist entries: | Descriptor Field | Definition | | MBO | The field must contain a 1. The MBO and MBMO fields are used to distinguish 32-bit and 64-bit item list entries. | | Item code | A word containing a user-supplied symbolic code specifying the item of information that $GETSYI is to return. The $SYIDEF macro defines these codes. A description of each item code is given in the Item Codes section. | | MBMO | The field must contain a --1. The MBMO and MBO fields are used to distinguish 32-bit and 64-bit item list entries. | | Buffer length | A quadword containing a user-supplied integer specifying the length (in bytes) of the buffer in which $GETSYI is to write the information. The length of the buffer needed depends on the item code specified in the item code field of the item descriptor. If the value of the buffer length is too small, $GETSYI truncates the data. | | Buffer address | A quadword containing the user-supplied 64-bit address of the buffer into which $GETSYI is to write the information. | | Return length address | A quadword containing the user-supplied 64-bit address of a word in which $GETSYI writes the length in bytes of the information it actually returned. | See the Item Codes section for a description of the various $GETSYIitem codes. iosb
| OpenVMS usage: | io_status_block | | type: | quadword (unsigned) | | access: | write only | | mechanism: | by 32- or 64-bit reference (Alpha) | | mechanism: | by 32-bit reference (VAX) |
I/O status block to receive the final completion status. Theiosb argument is the 32-bit address (on VAX systems)or the 32- or 64-bit address (on Alpha systems) of the quadword I/Ostatus block.When you specify the iosb argument, $GETSYI sets thequadword to 0 upon request initiation. Upon request completion, acondition value is returned to the first longword; the second longwordis reserved for future use. Though this argument is optional, HP strongly recommends that youspecify it, for the following reasons: - If you are using an event flag to signal the completion of the service, you can test the I/O status block for a condition value to be sure that the event flag was not set by an event other than service completion.
- If you are using the $SYNCH service to synchronize completion of the service, the I/O status block is a required argument for $SYNCH.
- The condition value returned in R0 and the condition value returned in the I/O status block provide information about different aspects of the call to the $GETSYI service. The condition value returned in R0 gives you information about the success or failure of the service call itself; the condition value returned in the I/O status block gives you information about the success or failure of the service operation. Therefore, to accurately assess the success or failure of the call to $GETSYI, you must check the condition values returned in both R0 and the I/O status block.
astadr
| OpenVMS usage: | ast_procedure | | type: | procedure value | | access: | call without stack unwinding | | mechanism: | by 32- or 64-bit reference (Alpha) | | mechanism: | by 32-bit reference (VAX) |
AST service routine to be executed when $GETSYI completes. Theastadr argument is the 32-bit address (on VAX systems)or the 32- or 64-bit address (on Alpha systems) of this routine.If you specify astadr, the AST routine executes at thesame access mode as the caller of the $GETSYI service. astprm
| OpenVMS usage: | user_arg | | type: | longword (unsigned) | | access: | read only | | mechanism: | by value |
AST parameter to be passed to the AST service routine specified by theastadr argument. The astprm argumentis the longword parameter.
Item CodesSYI$_ACTIVE_CPU_MASKOn Alpha systems, returns a value that represents a CPU-indexedbitvector. When a particular bit position is set, the processor withthat CPU ID value is a member of the instance's active set - thosecurrently participating in the OpenVMS SMP scheduling activities.SYI$_ACTIVECPU_CNTReturns a count of the CPUs actively participating in the current bootof the symmetric multiprocessing (SMP) system.Because this number is a longword, the buffer length field in the itemdescriptor should specify 4 (bytes). SYI$_ARCHFLAGReturns the architecture flags for the system.Because this number is a longword, the buffer length field in the itemdescriptor should specify 4 (bytes). SYI$_ARCH_NAMEReturns, as a character string, the name of the CPU architecture onwhich the process is executing. Currently, either of two strings isreturned: "Alpha" for Alpha or "VAX" for VAX.Because this name can include up to 15 characters, the buffer lengthfield in the item descriptor should specify 15 (bytes). SYI$_ARCH_TYPEReturns the type of CPU architecture on which the process is executing.SYI$_ARCH_TYPE returns 1 on VAX or 2 on Alpha.Because this number is a longword, the buffer length field in the itemdescriptor should specify 4 (bytes). SYI$_AVAIL_CPU_MASKOn Alpha systems, returns a value that represents a CPU-indexedbitvector. When a particular bit position is set, the processor withthat CPU ID value is a member of the instance's configure set - thoseowned by the partition and controlled by the issuing instance.SYI$_AVAILCPU_CNTReturns the number of CPUs available in the current boot of thesymmetric multiprocessing (SMP) system.Because this number is a longword, the buffer length field in the itemdescriptor should specify 4 (bytes). SYI$_BOOTTIMEReturns the time when the node was booted.Because the returned time is in the standard 64-bit absolute timeformat, the buffer length field in the item descriptor should specify 8(bytes). SYI$_CHARACTER_EMULATEDReturns the number 1 if the character string instructions are emulatedon the CPU and the value 0 if they are not.Because this number is a Boolean value (1 or 0), the buffer lengthfield in the item descriptor should specify 1 (byte). SYI$_CLUSTER_EVOTESReturns the number of votes expected to be found in the OpenVMS Clustersystem. The cluster determines this value by selecting the highestnumber from all of the following: each node's system parameterEXPECTED_VOTES, the sum of the votes currently in the cluster, and theprevious value for the number of expected votes.Because this number is a word in length, the buffer length field in theitem descriptor should specify 2 (bytes). SYI$_CLUSTER_FSYSIDReturns the system identification of the founding node, which is thefirst node in the OpenVMS Cluster system to boot.The cluster management software assigns this system identification tothe node. You can obtain this information by using the DCL command SHOWCLUSTER. Because the system identification is a 6-byte hexadecimalnumber, the buffer length field in the item descriptor should specify 6(bytes). SYI$_CLUSTER_FTIMEReturns the time when the founding node is booted. The founding node isthe first node in the OpenVMS Cluster system to boot.Because the returned time is in the standard 64-bit absolute timeformat, the buffer length field in the item descriptor should specify 8(bytes). SYI$_CLUSTER_MEMBERReturns the membership status of the node in the OpenVMS Clustersystem. The membership status specifies whether the node is currently amember of the cluster.Because the membership status of a node is described in a 1-byte bitfield, the buffer length field in the item descriptor should specify 1(byte). If bit 0 in the bit field is set, the node is a member of thecluster; if it is clear, then it is not a member of the cluster. SYI$_CLUSTER_NODESReturns the number (in decimal) of nodes currently in the OpenVMSCluster system.Because this number is a word in length, the buffer length field in theitem descriptor should specify 2 (bytes). SYI$_CLUSTER_QUORUMReturns the number (in decimal) that is the total of the quorum valuesheld by all nodes in the OpenVMS Cluster system. Each node's quorumvalue is derived from its system parameter EXPECTED_VOTES.Because this number is a word in length, the buffer length field in theitem descriptor should specify 2 (bytes). SYI$_CLUSTER_VOTESReturns the total number of votes held by all nodes in the OpenVMSCluster system. The number of votes held by any one node is determinedby that node's system parameter VOTES.Because this decimal number is a word in length, the buffer lengthfield in the item descriptor should specify 2 (bytes). SYI$_COMMUNITY_IDOn Alpha systems, returns the hardware community ID for the issuinginstance within the hard partition. Supported only on AlphaServersystems that support partitioning.SYI$_CONTIG_GBLPAGESReturns the maximum number of free, contiguous global CPU-specificpages. This number is the largest size global section that can becreated.Because this number is a longword, the buffer length in the itemdescriptor should specify 4 (bytes). SYI$_CPUOn VAX systems, returns the CPU processor type, as represented in theprocessor's system identification (SID) register.For example, the integer 1 represents a VAX--11/780 system and theinteger 6 represents a VAX 8530, VAX 8550, VAX 8700, or VAX 8800 system. Because the processor type is a longword decimal number, the bufferlength field in the item descriptor should specify 4 (bytes). The $PRDEF macro defines the following symbols for the processor types: | Processor | Symbol | | VAX-11/730 | PR$_SID_TYP730 | | VAX-11/750 | PR$_SID_TYP750 | | VAX-11/780, 785 | PR$_SID_TYP780 | | VAXstation II, II/GPX, and MicroVAX II | PR$_SID_TYPUV2 | | VAXstation 2000/MicroVAX 2000 | PR$_SID_TYP410 | | VAX 8200, 8250, 8300, 8350 | PR$_SID_TYP8SS | | VAX 8530, 8550, 8810 (8700), and 8820-N (8800) | PR$_SID_TYP8NN | | VAX 8600, 8650 | PR$_SID_TYP790 | | VAX 8820, 8830, 8840 | PR$_SID_TYP8PS | | VAXft 3000 Model 310 | PR$_SID_TYP520 | | VAXstation, MicroVAX 3100 series | PR$_SID_TYP420 | | MicroVAX 3300, 3400, 3500, 3600, 3800, 3900 | PR$_SID_TYP650 | | VAXstation 3520, 3540 | PR$_SID_TYP60 | | VAX 4000-300 | PR$_SID_TYP670 | | VAX 6000-200, 6000-300 series | PR$_SID_TYP9CC | | VAX 6000-400 series | PR$_SID_TYP9RR | | VAX 9000-200, 9000-400 series | PR$_SID_TYP9AQ | On Alpha systems, $GETSYI returns PR$_SID_TYP_NOTAVAX. For information about extended processor type codes, see thedescription for the SYI$_XCPU item code. SYI$_CPU_AUTOSTARTOn Alpha systems, returns a list of zeroes and ones, separated bycommands and indexed by CPU ID. Any entry with a value of one indicatesthat specific CPU will be brought into the OpenVMS active set if ittransitions into the current instance from outside, or is powered upwhile already owned.SYI$_CPU_FAILOVERReturns list of numeric partition IDs, separated by commas and indexedby CPU ID, that define the destination of the processor if the currentinstance should crash. Supported only on AlphaServer systems thatsupport partitioning.SYI$_CPUCAP_MASKOn Alpha systems, returns an array of quadword user capability masksfor all CPUs in the system. This array is indexed by CPU ID andcontains as many elements as the amount of space specified by thebuffer length field in the item descriptor.To minimize wasted space, a prior call to $GETSYI with SYI$_MAX_CPUSwill provide the number of CPUs that need to be retrieved. Multiplyingthat value by 8 bytes for each quadword provides the value to bewritten in the buffer length field of the item descriptor. SYI$_CPUCONFOn Alpha systems, returns the CPU Configuration bit mask: 0 through 31.SYI$_CPUTYPEOn Alpha systems, returns the processor type, as stored in the hardwarerestart parameter block (HWRPB).For example, the value of 2 represents a DECchip 21064 processor.Because this number is a longword, the buffer length field in the itemdescriptor should specify 4 (bytes). The following table shows the processor codes and processors: | Processor Code | Processor | | 2 | 21064 | | 4 | 21066, 21068, 21066A, 21068A | | 5 | 21164 | | 6 | 21064A | | 7 | 21164A | | 8 | 21264 | | 11 | 21264A | | 12 | 21264C | | 13 | 21264B | | 14 | 21264D | | 15 | 21364 | | 16 | 21364 | SYI$_CWLOGICALSReturns the number 1 if the clusterwide logical name database has beeninitialized on the CPU, or the value 0 if it has not been initialized.Because this number is a Boolean value (1 or 0), the buffer lengthfield in the item descriptor should specify 1 (byte).SYI$_DAY_OVERRIDEReturns the number 1 if the SET DAY command has been used to overridethe default primary and secondary day types in the user authorizationfile that are used to control user logins. $GETSYI returns the number 0if no override is currently in effect, and the contents of userauthorization file records for each user are being honored.SYI$_DAY_SECONDARYReturns the number 1 if any override with the SET DAY command has beenused to specify that the current day is to be considered a Secondaryday for user login purposes. $GETSYI returns the number 0 if anyoverride with the SET DAY command has been used to specify that thecurrent day is to be considered a Primary day for user login purposes.If $GETSYI returns the number 0 for SYI$_DAY_OVERRIDE, the numberreturned for SYI$_DAY_SECONDARY is meaningless.
 SYI$_DECIMAL_EMULATEDReturns the number 1 if the decimal string instructions are emulated onthe CPU and the value 0 if they are not.Because this number is a Boolean value (1 or 0), the buffer lengthfield in the item descriptor should specify 1 (byte). SYI$_DECNET_FULLNAMEReturns, as a character string, the DECnet for OpenVMS full name of thenode.Because the DECnet for OpenVMS full name of a node can contain up to255 characters, the buffer length field in the item descriptor shouldspecify 255 (bytes). SYI$_D_FLOAT_EMULATEDReturns the number 1 if the D_floating instructions are emulated on theCPU and 0 if they are not.Because this number is a Boolean value (1 or 0), the buffer lengthfield in the item descriptor should specify 1 (byte). SYI$_DEF_PRIO_MAXOn Alpha systems, returns the maximum priority for the defaultscheduling policy.Because this number is a longword, the buffer length field in the itemdescriptor should specify 4 (bytes). SYI$_DEF_PRIO_MINOn Alpha systems, returns the minimum priority for the defaultscheduling policy.Because this number is a longword, the buffer length field in the itemdescriptor should specify 4 (bytes). SYI$_ERLBUFFERPAGESReturns the number of pages (on VAX systems) or pagelets (on Alphasystems) in an error log buffer.Because this number is a longword, the buffer length field in the itemdescriptor should specify 4 (bytes). SYI$_ERRORLOGBUFFERSReturns the number of system pages (on VAX systems) or pagelets (onAlpha systems) in use as buffers for the error logger.Because this number is a word in length, the buffer length field in theitem descriptor should specify 2 (bytes). SYI$_F_FLOAT_EMULATEDReturns the number 1 if the F_floating instructions are emulated on theCPU and 0 if they are not.Because this number is a Boolean value (1 or 0), the buffer lengthfield in the item descriptor should specify 1 (byte). SYI$_FREE_GBLPAGESReturns the current number of free global pages. The system parameterGBLPAGES sets the number of global pages that can exist systemwide.Because the current number is a longword, the buffer length in the itemdescriptor should specify 4 (bytes). SYI$_FREE_GBLSECTSReturns the current number of free global section table entries. Thesystem parameter GBLSECTIONS sets the maximum number of global sectionsthat can exist systemwide.Because the current number is a longword, the buffer length in the itemdescriptor should specify 4 (bytes). SYI$_G_FLOAT_EMULATEDReturns the number 1 if the G_floating instructions are emulated on theCPU and the value 0 if they are not.Because this number is a Boolean value (1 or 0), the buffer lengthfield in the item descriptor should specify 1 (byte). SYI$_GALAXY_IDOn Alpha systems, returns the 128-bit Galaxy ID. Supported only on AlphaServer GS series systems.SYI$_GALAXY_MEMBEROn Alpha systems, returns 1 if you are member of a Galaxy sharingcommunity, 0 if you are not a member. Supported only on AlphaServer GS series systems.SYI$_GALAXY_PLATFORMOn Alpha systems, returns 1 if you are running on a Galaxy platform, 0if you are not running on a Galaxy platform. Supported only on AlphaServer GS series systems.SYI$_GALAXY_SHMEMSIZEOn Alpha systems, returns the number of shared memory pages. If thecurrent instance is not a member of a Galaxy, no shared memory isreported. Supported only on AlphaServer GS series systems.SYI$_GH_RSRVPGCNTOn Alpha systems, returns the number of pages covered by granularityhints to reserve for use by the Install utility after system startuphas completed.Because this number is a longword, the buffer length field in the itemdescriptor should specify 4 (bytes). SYI$_GLX_FORMATIONOn Alpha systems, returns the a time-stamp string when the Galaxyconfiguration, of which this instance is a member, was created.Supported only on AlphaServer GS series systems.SYI$_GLX_MAX_MEMBERSOn Alpha systems, returns the maximum count of instances that may jointhe current Galaxy configuration. Supported only on AlphaServer GS series systems.SYI$_GLX_MBR_MEMBEROn Alpha systems, returns the 64-byte integer. Each 8 bytes representsa Galaxy member number, listed from 7 to 0. The value is 1 if theinstance is currently a member, 0 if not a member. Supported only on AlphaServer GS series systems.SYI$_GLX_MBR_NAMEOn Alpha systems, returns a string indicating the names which are knownin the Galaxy membership. Supported only on AlphaServer GS series systems.SYI$_GLX_TERMINATIONOn Alpha systems, returns a time-stamp string when the Galaxyconfiguration, of which this instance last was a member, wasterminated. Supported only on AlphaServer GS series systems.SYI$_H_FLOAT_EMULATEDReturns the number 1 if the H_floating instructions are emulated on theCPU and the value 0 if they are not.Because this number is a Boolean value (1 or 0), the buffer lengthfield in the item descriptor should specify 1 (byte). SYI$_HP_ACTIVE_CPU_CNTReturns the number of active CPUs in this hard partition that are notcurrently in firmware console mode. For OpenVMS, this implies that theCPU is in, or in the process of joining, the active set in one of theinstances in the hard partition. Supported only on AlphaServer systems that support partitioning.SYI$_HP_ACTIVE_SP_CNTReturns the count of active operating system instances currentlyexecuting within the hard partition. Supported only on AlphaServer systems that support partitioning.SYI$_HP_CONFIG_SBB_CNTReturns a count of the existing system building blocks within thecurrent hard partition. Supported only on AlphaServer systems that support partitioning.SYI$_HP_CONFIG_SP_CNTReturns the maximum count of soft partitions within the current hardpartition. This count does not imply that an operating system instanceis currently running within any given soft partition. Supported only on AlphaServer systems that support partitioning.SYI$_HW_MODELReturns a small integer that can be used to identify the model type ofthe node.An integer greater than 1023 indicates an Alpha node. An integer less than or equal to 1023 indicates a VAX node. The $ALPHADEF and $VAXDEF macros in SYS$LIBRARY:STARLET define themodel type integers. See the tables under the SYI$_HW_NAME item codefor the VAX processor names and the corresponding model types. Because SYI$_HW_MODEL is a word, the buffer length field in the itemdescriptor should specify 2 (bytes). SYI$_HW_NAMEReturns the model name string of the node. The model name is acharacter string that describes the model of the node (such as VAX8800, MicroVAX II). The model name usually corresponds to the nameplatethat appears on the outside of the CPU cabinet.Because SYI$_HW_NAME can include up to 60 characters plus one for thebyte count, the buffer length field in the item descriptor shouldspecify 61 (bytes). The following table lists the Alpha model processor names and thecorresponding model types: | Alpha Model Processor Name | Alpha Model Type | | DEC 3000 400 | ALPHA$K_A3000_400W | | DEC 3000 400S | ALPHA$K_A3000_400S | | DEC 3000 500 | ALPHA$K_A3000_500W | | DEC 3000 500S | ALPHA$K_A3000_500S | | DEC 4000 610 | ALPHA$K_A4000_610 | | DEC 4000 620 | ALPHA$K_A4000_620 | | DEC 4000 630 | ALPHA$K_A4000_630 | | DEC 4000 640 | ALPHA$K_A4000_640 | | DEC 7000 Model 610 | ALPHA$K_A7000_610 | | DEC 7000 Model 620 | ALPHA$K_A7000_620 | | DEC 7000 Model 630 | ALPHA$K_A7000_630 | | DEC 7000 Model 640 | ALPHA$K_A7000_640 | | DEC 10000 Model 610 | ALPHA$K_A10000_610 | | DEC 10000 Model 620 | ALPHA$K_A10000_620 | | DEC 10000 Model 630 | ALPHA$K_A10000_630 | | DEC 10000 Model 640 | ALPHA$K_A10000_640 | The following table lists the VAX model processor names and thecorresponding model types: | VAX Model Processor Name | VAX Model Type | | VAX-11/730 | VAX$K_V730 | | VAX-11/750 | VAX$K_V750 | | VAX-11/780 | VAX$K_V780 | | VAX-11/785 | VAX$K_V785 | | MicroVAX II | VAX$K_VUV2 | | VAXstation II | VAX$K_VWS2 | | VAXstation II/GPX | VAX$K_VWSD | | VAXstation 2000 | VAX$K_VWS2000 | | MicroVAX 2000 | VAX$K_VUV2000 | | VAXstation 2000/GPX | VAX$K_VWSD2000 | | VAX 8200 | VAX$K_V8200 | | VAX 8250 | VAX$K_V8250 | | VAX 8300 | VAX$K_V8300 | | VAX 8350 | VAX$K_V8350 | | VAX 8530 | VAX$K_V8500 | | VAX 8550 | VAX$K_V8550 | | VAX 8600 | VAX$K_V8600 | | VAX 8650 | VAX$K_V8650 | | VAX 8810 (8700) | VAX$K_V8700 | | VAX 8820-N (8800) | VAX$K_V8800 | | VAX 8820, 8830, or 8840 with one CPU enabled | VAX$K_V8810 | | VAX 8820 | VAX$K_V8820 | | VAX 8830 | VAX$K_V8830 | | VAX 8840 | VAX$K_V8840 | | VAXft 3000 Model 310 | VAX$K_V520FT | | VAXstation 3520 | VAX$K_V3520L | | VAXstation 3540 | VAX$K_V3540L | | VAX 4000-300 timeshare | VAX$K_V670 | | VAX 4000-300 server | VAX$K_V670_S | | VAX 6000-210 timeshare | VAX$K_V6210_T | | VAX 6000-220 timeshare | VAX$K_V6220_T | | VAX 6000-230 timeshare | VAX$K_V6230_T | | VAX 6000-240 timeshare | VAX$K_V6240_T | | VAX 6000-250 timeshare | VAX$K_V6250_T | | VAX 6000-260 timeshare | VAX$K_V6260_T | | VAX 6000-210 server | VAX$K_V6210_S | | VAX 6000-220 server | VAX$K_V6220_S | | VAX 6000-310 timeshare | VAX$K_V6310_T | | VAX 6000-320 timeshare | VAX$K_V6320_T | | VAX 6000-330 timeshare | VAX$K_V6330_T | | VAX 6000-340 timeshare | VAX$K_V6340_T | | VAX 6000-350 timeshare | VAX$K_V6350_T | | VAX 6000-360 timeshare | VAX$K_V6360_T | | VAX 6000-310 server | VAX$K_V6310_S | | VAX 6000-320 server | VAX$K_V6320_S | | VAX 6000-410 timeshare | VAX$K_V9RR10_T | | VAX 6000-420 timeshare | VAX$K_V9RR20_T | | VAX 6000-430 timeshare | VAX$K_V9RR30_T | | VAX 6000-440 timeshare | VAX$K_V9RR40_T | | VAX 6000-450 timeshare | VAX$K_V9RR50_T | | VAX 6000-460 timeshare | VAX$K_V9RR60_T | | VAX 6000-410 server | VAX$K_V9RR10_S | | VAX 6000-420 server | VAX$K_V9RR20_S | | VAX 9000-210 | VAX$K_V9AR10 | | VAX 9000-410 | VAX$K_V9AQ10 | | VAX 9000-420 | VAX$K_V9AQ20 | | VAX 9000-430 | VAX$K_V9AQ30 | | VAX 9000-440 | VAX$K_V9AQ40 | SYI$_IO_PREFER_CPUOn Alpha systems, returns the bit mask of CPUs available to be FastPath preferred CPUs.SYI$_ITB_ENTRIESOn Alpha systems, returns the number of instruction stream translationbuffer entries that support granularity hints to be allocated forresident code.Because this number is a longword, the buffer length field in the itemdescriptor should specify 4 (bytes). SYI$_MAX_CPUSOn Alpha systems, returns the maximum number of CPUs that could berecognized by this instance.SYI$_MAX_PFNReturns the highest numbered PFN in use by the operating system. Thehighest numbered PFN used by OpenVMS is influenced by thePHYSICAL_MEMORY system parameter.Because this number is a longword, the buffer length field in the itemdescriptor should specify 4 (bytes). SYI$_MEMSIZEReturns the total number of pages of physical memory in the systemconfiguration.Because this number is a longword, the buffer length field in the itemdescriptor should specify 4 (bytes). SYI$_NODE_AREAReturns the DECnet area of the node.Because the DECnet area is a longword decimal number, the buffer lengthfield in the item descriptor should specify 4 (bytes). SYI$_NODE_CSIDReturns the OpenVMS Cluster system ID (CSID) of the node. The CSID is alongword hexadecimal number assigned to the node by the clustermanagement software.Because the CSID is a longword, the buffer length field in the itemdescriptor should specify 4 (bytes). SYI$_NODE_EVOTESReturns the number of votes the node expects to find in the OpenVMSCluster system. This number is determined by the system parameterEXPECTED_VOTES.Because the number is a word in length, the buffer length field in theitem descriptor should specify 2 (bytes). SYI$_NODE_HWVERSReturns the platform-specific hardware version information associatedwith the node. The high word of the buffer contains the CPU type. The$VAXDEF and $ALPHADEF macros define the CPU model types for VAX andAlpha systems, respectively. (HP recommends acquiring the model typeusing the SYI$_HW_MODEL item code.)Because the hardware version is a 12-byte hexadecimal number, thebuffer length field in the item descriptor should specify 12 (bytes). SYI$_NODE_NUMBERReturns the DECnet for OpenVMS number of the node.Because the DECnet for OpenVMS number is a longword decimal number, thebuffer length field in the item descriptor should specify 4 (bytes). SYI$_NODE_QUORUMReturns the value (in decimal) of the quorum held by the node. Thisnumber is derived from the node's system parameter EXPECTED_VOTES.Because this number is a word in length, the buffer length field in theitem descriptor should specify 2 (bytes). SYI$_NODE_SWINCARNReturns the software incarnation of the node.Because the software incarnation of the node is an 8-byte hexadecimalnumber, the buffer length field in the item descriptor should specify 8(bytes). SYI$_NODE_SWTYPEReturns the software type of the node. The software type indicateswhether the node is a VAX system, an Alpha system, or an HSC storagecontroller.Because the software type is a 4-byte ASCII string, the buffer lengthfield in the item descriptor should specify 4 (bytes). SYI$_NODE_SWVERSReturns the software version of the node.Because the software version is a 4-byte ASCII string, the bufferlength field in the item descriptor should specify 4 (bytes). SYI$_NODE_SYSTEMIDReturns the system identification of the node.The OpenVMS Cluster management software assigns this systemidentification to the node. You can obtain this information by usingthe DCL command SHOW CLUSTER. Because the system identification is a6-byte hexadecimal number, the buffer length field in the itemdescriptor should specify 6 (bytes). SYI$_NODE_VOTESReturns the number (in decimal) of votes held by the node. This numberis determined by the node's system parameter VOTES.Because this number is a word in length, the buffer length field in theitem descriptor should specify 2 (bytes). SYI$_NODENAMEReturns, as a character string, the name of the node in the bufferspecified in the item list.Because this name can include up to 15 characters, the buffer lengthfield in the item descriptor should specify 15 (bytes). SYI$_PAGEFILE_FREEReturns the number of free pages in the currently installed page files.Because this number is a longword, the buffer length field in the itemdescriptor should specify 4 (bytes). SYI$_PAGEFILE_PAGEReturns the number of pages in the currently installed page files.Because this number is a longword, the buffer length field in the itemdescriptor should specify 4 (bytes). SYI$_PAGE_SIZEReturns the number of CPU-specific bytes per page in the system.On VAX systems, $GETSYI always returns 512. On Alpha systems, CPU page size varies from system to system. On Alpha and VAX systems, because this number is a longword, the bufferlength field in the item descriptor should specify 4 (bytes). SYI$_PARTITION_IDOn Alpha systems, returns the soft partition ID. Supported only on AlphaServer systems that support partitioning.SYI$_PFN_MEMORY_MAPReturns a map describing the system's use of physical memory. Thefollowing figure shows an example of a physical memory map:
 The first longword of the physical memory contains a count ofdescriptors. This number is equal to the value returned when theSYI$_PMD_COUNT item code is specified. Each descriptor contains at least 3 longwords: a word containing thelength of the descriptor (always use PMM$C_LENGTH when determiningdescriptor size); a flags word (whose bits are defined in the followingtable); and the starting PFN for that physical memory cluster and thenumber of PFNs in that cluster. | Bit | Meaning When Set | | PMM$V_CONSOLE | The physical memory descriptor is in use by the console (hardware). | | PMM$V_OPENVMS | The physical memory descriptor is in use by OpenVMS. | | PMM$V_AVAILABLE | The physical descriptor is not in use by either the console (hardware) or OpenVMS. | | Remaining bits | The remaining bits in the PMM$W_FLAGS word are reserved for HP. | The structure definition for the physical memory descriptor resides inPMMDEF.H. Because the size of the physical memory map returned by $GETSYI canvary from system to system, HP recommends using the following stepswhen using this item code: - Call $GETSYI first using the SYI$_PMD_COUNT to obtain the number of physical memory descriptors.
- Dynamically create a buffer to which $GETSYI can copy the physical memory map. The size of the buffer can be computed with the following formula:
map_buffer_size = (PMM$C_LENGTH * ret-val) + 4 |
where: - PMM$C_LENGTH is the size of an individual physical memory descriptor.
- ret-val is the return value from a call to $GETSYI specifying the SYI$_PMD_COUNT item code.
- 4 is the number of bytes occupied by the descriptor count in the physical memory map.
SYI$_PHYSICALPAGESReturns the total number of PFNs that exist between the first PFN(typically PFN 0) and the highest numbered PFN.Because this number is a longword, the buffer length field in the itemdescriptor should specify 4 (bytes). SYI$_PMD_COUNTReturns the total number of physical memory descriptors defined by thesystem. The return value of this parameter can be used to determine thebuffer size to use when specifying the SYI$_PFN_MEMORY_MAP item code.Because this number is a longword, the buffer length field in the itemdescriptor should specify 4 (bytes). SYI$_POTENTIAL_CPU_MASKOn Alpha systems, returns a value that represents a CPU-indexedbitvector. When a particular bit position is set, the processor withthat CPU ID value is a member of the instance's potential set. A CPU inthe potential set implies that it could actively join the OpenVMSactive set for this instance if it is ever owned by it. To meet thisrule the CPU's characteristics must match hardware and softwarecompatibility rules defined particularly for that instance.SYI$_POTENTIALCPU_CNTOn Alpha systems, returns the count of CPUs in the hard partition thatare members of the potential set for this instance. A CPU in thepotential set implies that it could actively join the OpenVMS activeset for this instance if it is ever owned by it. To meet this rule theCPU's characteristics must match hardware and software compatibilityrules defined particularly for that instance.SYI$_POWERED_CPU_MASKOn Alpha systems, returns a value that represents a CPU-indexedbitvector. When a particular bit position is set, the processor withthat CPU ID value is a member of the instance's powered set - thoseCPUs physically existing within the hard partition and powered up foroperation.SYI$_POWEREDCPU_CNTOn Alpha systems, returns the count of CPUs in the hard partition thatare physically powered up.SYI$_PRESENT_CPU_MASKOn Alpha systems, returns a value that represents a CPU-indexedbitvector. When a particular bit position is set, the processor withthat CPU ID value is a member of the instance's present set - thoseCPUs physically existing within the hard partition. Being in thepresent set does not imply that it is part of the powered set.SYI$_PRESENTCPU_CNTOn Alpha systems, returns the count of CPUs in the hard partition thatphysically reside in a hardware slot.SYI$_PRIMARY_CPUIDOn Alpha systems, returns the CPU ID of the primary processor for thisOpenVMS instance.SYI$_PROCESS_SPACE_LIMITOn Alpha systems, this item code returns the 64-bit virtual addresssucceeding the last available process private address. The valuereturned is the upper bound on the process private address space. Thevalue returned is the same for every process on the system.Because this number is a quadword, the buffer length field in the itemdescriptor should specify 8 (bytes). SYI$_PSXFIFO_PRIO_MAXOn Alpha systems, returns the maximum priority for the POSIX FIFOscheduling policy.Because this number is a longword, the buffer length field in the itemdescriptor should specify 4 (bytes). SYI$_PSXFIFO_PRIO_MINOn Alpha systems, returns the minimum priority for the POSIX FIFOscheduling policy.Because this number is a longword, the buffer length field in the itemdescriptor should specify 4 (bytes). SYI$_PSXRR_PRIO_MAXOn Alpha systems, returns the maximum priority for the POSIXround-robin scheduling policy.Because this number is a longword, the buffer length field in the itemdescriptor should specify 4 (bytes). SYI$_PSXRR_PRIO_MINOn Alpha systems, returns the minimum priority for the POSIXround-robin scheduling policy.Because this number is a longword, the buffer length field in the itemdescriptor should specify 4 (bytes). SYI$_PT_BASEOn Alpha systems, returns the 64-bit virtual address of the base of thepage tables. The value returned is the same for every process on thesystem.Because this number is a quadword, the buffer length field in the itemdescriptor should specify 8 (bytes). SYI$_PTES_PER_PAGEOn Alpha systems, returns the maximum number of CPU-specific pages thatcan be mapped by one page table page.Because this number is a longword, the buffer length field in the itemdescriptor should specify 4 (bytes). SYI$_RAD_CPUSOn Alpha systems, returns a longword array of RAD/CPU pairs that canpotentially be in this operating system instance. If there is no RADsupport, all potential CPUs are in RAD 0. The array is terminated witha -1,-1 pair.Note: OpenVMS support for RADs is available only on the AlphaServer GS series systems. For more information about using RADs, refer to the HP OpenVMS Alpha Partitioning and Galaxy Guide. SYI$_RAD_MEMSIZEOn Alpha systems, returns a longword array of RAD/page count pairs. Thenumber of pages of private memory is returned. If there is no RADsupport, all memory is reported in RAD 0. The array is terminated witha -1,-1 pair.Note: OpenVMS support for RADs is available only on the AlphaServer GS series systems. For more information about using RADs, refer to the HP OpenVMS Alpha Partitioning and Galaxy Guide. SYI$_RAD_MAX_RADOn Alpha systems, returns the maximum number of RADs possible on thisplatform. If there is no RAD support, 1 is returned.Note: OpenVMS support for RADs is available only on the AlphaServer GS series systems. For more information about using RADs, refer to the HP OpenVMS Alpha Partitioning and Galaxy Guide. SYI$_RAD_SHMEMSIZEOn Alpha systems, returns a longword array of RAD/page count pairs. Thenumber of pages of shared memory is returned. If there is no RADsupport, all shared memory is reported in RAD 0. If the currentinstance is not a member of a Galaxy, no shared memory is reported. Thearray is terminated with a -1,-1 pair.Note: OpenVMS support for RADs is available only on the AlphaServer GS series systems. For more information about using RADs, refer to the HP OpenVMS Alpha Partitioning and Galaxy Guide. SYI$_REAL_CPUTYPEReturns the actual CPU type of the primary CPU of the system.See the SYI$_CPUTYPE item code for a list of symbols and processors. SYI$_SCSNODEReturns the Galaxy instance name. Supported only on AlphaServer systems that support partitioning.SYI$_SCS_EXISTSReturns a longword value that is interpreted as Boolean. If the valueis 1, the System Communication Subsystem (SCS) is currently loaded onthe node; if the value is 0, the SCS is not currently loaded.SYI$_SERIAL_NUMBERReturns the system serial number from out of the Hardware RestartParameter Block (HWRPB).SYI$_SHARED_VA_PTESOn Alpha systems, returns the 64-bit virtual address of the PTE thatmarks the boundary between process-private PTEs and system-shared PTEs.The value returned is the same for every process on the system.Because this number is a quadword, the buffer length field in the itemdescriptor should specify 8 (bytes). SYI$_SIDReturns the contents of the system identification register of the node.On Alpha systems, SYI$_SID returns a value in which all fields are 0except the CPU-type field, which always contains the value 256. Because the value of this register is a longword hexadecimal number,the buffer length field in the item descriptor should specify 4 (bytes). SYI$_SWAPFILE_FREEReturns the number of free pages in the currently installed swappingfiles.Because this number is a longword, the buffer length field in the itemdescriptor should specify 4 (bytes). SYI$_SWAPFILE_PAGEReturns the number of pages in the currently installed swapping files.Because this number is a longword, the buffer length field in the itemdescriptor should specify 4 (bytes). SYI$_SYSTEM_RIGHTSReturns the system rights list as an array of quadword identifiers.Each entry consists of a longword identifier value and the followinglongword identifier attributes: | Bit Position | Meaning When Set | | KGB$V_DYNAMIC | Allows holders of the identifier to remove it from or add it to the process rights list using the DCL command SET RIGHTS_LIST. | | KGB$V_NOACCESS | Makes any access rights of the identifier null and void. This attribute is intended as a modifier for a resource identifier or the Subsystem attribute. | | KGB$V_RESOURCE | Allows holders of an identifier to charge disk space to the identifier. It is used only for file objects. | | KGB$V_SUBSYSTEM | Allows holders of the identifier to create and maintain protected subsystems by assigning the Subsystem ACE to the application images in the subsystem. | Allocate a buffer that is sufficient to hold the system rights list,because $GETSYI returns only as much of the list as will fit in thebuffer. SYI$_SYSTYPEOn Alpha systems, returns the name of the family or system hardwareplatform. For example, the integer 2 represents a DEC 4000 processor,the integer 3 represents a DEC 7000 or DEC 10000 processor, and theinteger 4 represents a DEC 3000 processor.SYI$_VERSIONReturns, as a character string, the software version number of theOpenVMS operating system running on the node.Because the version number is 8-byte blank-filled, the buffer lengthfield in the item descriptor should specify 8 (bytes). SYI$_VECTOR_EMULATORReturns a byte, the low-order bit of which, when set, indicates thepresence of the Vector Instruction Emulator facility (VVIEF) in thesystem.SYI$_VP_MASKReturns a longword mask, the bits of which, when set, indicate whichprocessors in the system have vector coprocessors.SYI$_VP_NUMBERReturns an unsigned longword containing the number of vector processorsin the system.SYI$_XCPUReturns the extended CPU processor type of the node.You should obtain the general processor type value first by using theSYI$_CPU item code. For some of the general processor types, extendedprocessor type information is provided by the item code, SYI$_XCPU. Forother general processor types, the value returned by the SYI$_XCPU itemcode is currently undefined. Because the processor type is a longword decimal number, the bufferlength field in the item descriptor should specify 4 (bytes). On VAX systems, the $PRDEF macro defines the following symbols for theextended processor types: VAX
Processor
Type Symbol | Extended
Processor
Type | Extended
Processor
Symbol | | PR$_SID_TYPUV | MicroVAX II
VAXstation II | PR$_XSID_UV_UV2 | | | MicroVAX 2000
VAXstation 2000 | PR$_XSID_UV_410 | | PR$_SID_TYPCV | MicroVAX 3300, 3400, 3500, 3600, 3800, 3900 series | PR$_XSID_CV_650 | | | VAX 6000-200, 6000-300 series | PR$_XSID_CV_9CC | | | VAXstation 3520, 3540 | PR$_XSID_CV_60 | | | VAXstation 3100 series | PR$_XSID_CV_420 | | | VAXft 3000 Model 310 | PR$_XSID_CV_520 | | PR$_SID_TYP8NN | VAX 8530 | PRS$_XSID_N8500 | | | VAX 8550 | PRS$_XSID_N8550 | | | VAX 8810 (8700) | PRS$_XSID_N8700 | | | VAX 8820-N (8800) | PRS$_XSID_N8800 | | PR$_SID_TYPRV | VAX 4000-300 | PR$_XSID_RV_670 | | | VAX 6000-400 series | PR$_XSID_RV_9RR | SYI$_XSIDReturns processor-specific information. For the MicroVAX II system,this information is the contents of the system type register of thenode. The system type register contains the full extended informationused in determining the extended system type codes. For otherprocessors, the data returned by SYI$_XSID is currently undefined.Because the value of this register is a longword hexadecimal number,the buffer length field in the item descriptor should specify 4 (bytes). SYI$_xxxxReturns the current value of the system parameter named xxxxfor the node.The buffer must specify a longword into which $GETSYI writes the valueof the specified system parameter. For a list and description of allsystem parameters, refer to the HP OpenVMS System Management Utilities Reference Manual.
DescriptionThe Get Systemwide Information service returns information about thelocal system or about other systems in an OpenVMS Cluster configuration.Required Access or Privileges
None Required Quota
This service uses the process's AST limit quota (ASTLM). Related Services
$ALLOC, $ASSIGN, $BRKTHRU, $BRKTHRUW, $CANCEL, $CREMBX, $DALLOC,$DASSGN, $DELMBX, $DEVICE_SCAN, $DISMOU, $GETDVI, $GETDVIW, $GETMSG,$GETQUI, $GETQUIW, $INIT_VOL, $MOUNT, $PUTMSG, $QIO, $QIOW, $SNDERR,$SNDJBC, $SNDJBCW, $SNDOPR
Condition Values Returned | SS$_NORMAL | The service completed successfully. | | SS$_ACCVIO | The caller cannot read the item list, cannot write to the buffer specified by the buffer address field in an item descriptor, or cannot write to the return length address field in an item descriptor. | | SS$_BADPARAM | The item list contains an invalid item code. | | SS$_EXASTLM | The process has exceeded its AST limit quota. | | SS$_NOMORENODE | You requested a wildcard operation, and $GETSYI has returned information about all available nodes. | | SS$_NOSUCHNODE | The specified node does not exist or is not currently a member of the OpenVMS Cluster system. | | SS$_UNREACHABLE | Remote node is not currently reachable. |
Condition Values Returned in the I/O Status Block1Same as those returned in R0.
Example |
/* Defining __NEW_STARLET enables the program to benefit from better type checking for prototypes and structures provided by OpenVMS. */#define __NEW_STARLET 1#include <efndef> /* No Event Flag Event Flag */#include <iledef> /* Item List Entry Definitions */#include <iosbdef> /* I/O Status Block Structure Definition */#include <starlet> /* Function Prototypes for System Services */#include <stdio> /* C Standard I/O Functions */#include <string> /* memset Prototype */#include <syidef> /* $GETSYI Item Code Definitions */#define NUM_ILE 3#define BUFFER_SIZE 20/* Macro to initialize a 32-bit item_list_3. */#define init_ile32(ile, length, code, bufaddr, retlen_addr) \{ (ile)->ile3$w_length = (length); \ (ile)->ile3$w_code = (code); \ (ile)->ile3$ps_bufaddr = (bufaddr); \ (ile)->ile3$ps_retlen_addr = (retlen_addr); }/* Simple status checking macro. */#define bad_status(status) (((status) & 1) != 1)main (){char node_name [BUFFER_SIZE], version_string [BUFFER_SIZE];int status;unsigned short node_name_length, version_string_length;ILE3 syi_ile [NUM_ILE];IOSB iosb;/* Zeroing the item list has the effect of creating the terminating entry. */ memset (syi_ile, 0, ILE3$K_LENGTH*NUM_ILE);/* Initialize the item list entries to fetch the operating system version and the node name. */ init_ile32 ( &syi_ile [0], BUFFER_SIZE, SYI$_VERSION, version_string, &version_string_length); init_ile32 ( &syi_ile [1], BUFFER_SIZE, SYI$_NODENAME, node_name, &node_name_length); status = sys$getsyiw ( EFN$C_ENF, NULL, NULL, &syi_ile, &iosb, NULL, 0); if (bad_status (status)) return status; if (bad_status (iosb.iosb$w_status)) return iosb.iosb$w_status;/* Zero terminate the strings before displaying them. */ version_string [version_string_length] = '\0'; node_name [node_name_length] = '\0'; printf ("Version: %s Node Name: %s\n", version_string, node_name);} | This example C program demonstrates how to use $GETSYIW to obtain theoperating system version number string and the node name.
$GETSYIWReturns information about the local system or about other systems in acluster.The $GETSYIW service completes synchronously; that is, it returns tothe caller with the requested information. For asynchronous completion,use the Get Systemwide Information ($GETSYI) service; $GETSYI returnsto the caller after queuing the information request, without waitingfor the information to be returned. In all other respects, theseservices are identical; refer to the documentation about $GETSYI forinformation about the $GETSYIW service. For additional information about system service completion, refer tothe Synchronize ($SYNCH) service. On Alpha systems, this service accepts 64-bit addresses.
FormatSYS$GETSYIW [efn] ,[csidadr] ,[nodename] ,itmlst [,iosb] [,astadr][,astprm]
C Prototypeint sys$getsyiw (unsigned int efn, unsigned int *csidadr, void*nodename, void *itmlst, struct _iosb *iosb, void(*astadr)(__unknown_params), int astprm); You must specify either the csidadr or thenodename argument, but not both. For wildcardoperations, however, you must use the csidadr argument.
$GETTIMReturns the current system time in a 64-bit format.On Alpha systems, this service accepts 64-bit addresses.
FormatSYS$GETTIM timadr
C Prototypeint sys$gettim (struct _generic_64 *timadr);
Argumenttimadr
| OpenVMS usage: | date_time | | type: | quadword (unsigned) | | access: | write only | | mechanism: | by 32- or 64-bit reference (Alpha) | | mechanism: | by 32-bit reference (VAX) |
The 32- or 64-bit address (on Alpha systems) or the 32-bit address (onVAX systems) of a quadword to receive the current time in 64-bit format.
DescriptionThe Get Time service returns the current system time in 64-bit format.The quadword is the number of nanoseconds since November 17, 1858.Based upon system time initialization, all bits in the time quadwordare valid.On VAX systems, system time is updated every 10 milliseconds. On Alpha systems, the frequency at which system time is updated varies,depending on the clock frequency of the Alpha processor, orapproximately 1 millisecond. Required Access or Privileges
None Required Quota
None Related Services
$ASCTIM, $BINTIM, $CANTIM, $CANWAK, $NUMTIM, $SCHDWK, $SETIME, $SETIMR For additional information about the system time, refer to theHP OpenVMS System Manager's Manual.
Condition Values Returned | SS$_NORMAL | The service completed successfully. | | SS$_ACCVIO | The quadword to receive the time cannot be written by the caller. |
$GETUAIReturns authorization information about a specified user.
FormatSYS$GETUAI [nullarg] ,[contxt] ,usrnam ,itmlst ,[nullarg] ,[nullarg],[nullarg]
C Prototypeint sys$getuai (unsigned int efn, unsigned int *contxt, void *usrnam,void *itmlst, struct _iosb *iosb, void (*astadr)(__unknown_params), intastprm);
Argumentsnullarg
| OpenVMS usage: | null_arg | | type: | longword (unsigned) | | access: | read only | | mechanism: | by value |
Placeholding argument reserved to HP.efn
| OpenVMS usage: | ef_number | | type: | longword (unsigned) | | access: | read only | | mechanism: | by value |
Placeholding argument reserved to HP.contxt
| OpenVMS usage: | longword | | type: | longword (unsigned) | | access: | modify | | mechanism: | by reference |
An optional longword used to maintain an open channel to theauthorization file. The contxt argument is the addressof a longword to receive a $GETUAI context value. If thecontxt argument is specified on the initial call, thislongword should contain the value --1, and on subsequent calls, thevalue of the contxt argument from the previous callshould be passed back in.usrnam
| OpenVMS usage: | char_string | | type: | character-coded text string | | access: | read only | | mechanism: | by descriptor--fixed-length string descriptor |
Name of the user about whom $GETUAI returns authorization information.The usrnam argument is the address of a descriptorpointing to a character text string containing the user name. The username string can contain a maximum of 12 alphanumeric characters.itmlst
| OpenVMS usage: | item_list_3 | | type: | longword (unsigned) | | access: | read only | | mechanism: | by reference |
Item list specifying which information from the specified user's userauthorization file (UAF) record is to be returned. Theitmlst argument is the address of a list of one ormore item descriptors, each of which specifies an item code. The itemlist is terminated by an item code value of 0 or by a longword value of0.The following diagram depicts the structure of a single item descriptor:
 The following table defines the item descriptor fields: | Descriptor Field | Definition | | Buffer length | A word specifying the length (in bytes) of the buffer in which $GETUAI is to write the information. The length of the buffer varies, depending on the item code specified in the item code field of the item descriptor, and is given in the description of each item code. If the value of the buffer length field is too small, $GETUAI truncates the data. | | Item code | A word containing a user-supplied symbolic code specifying the item of information that $GETUAI is to return. The $UAIDEF macro defines these codes. | | Buffer address | A longword containing the user-supplied address of the buffer in which $GETUAI is to write the information. | | Return length address | A longword containing the user-supplied address of a word in which $GETUAI writes the length in bytes of the information it actually returned. | The symbolic codes have the following format: See the Item Codes section for descriptions of the various $GETUAI itemcodes. iosb
| OpenVMS usage: | io_status_block | | type: | quadword (unsigned) | | access: | write only | | mechanism: | by reference |
Placeholding argument reserved to HP.astadr
| OpenVMS usage: | ast_procedure | | type: | procedure entry mask | | access: | call without stack unwinding | | mechanism: | by reference |
Placeholding argument reserved to HP.astprm
| OpenVMS usage: | user_arg | | type: | longword (unsigned) | | access: | read only | | mechanism: | by value |
Placeholding argument reserved to HP.
Item CodesUAI$_ACCOUNTReturns, as a blank-filled 32-character string, the account name of theuser.An account name can include up to 8 characters. Because the accountname is a blank-filled string, however, the buffer length field of theitem descriptor should specify 32 (bytes). UAI$_ASTLMReturns the AST queue limit.Because this decimal number is a word in length, the buffer lengthfield in the item descriptor should specify 2 (bytes). UAI$_BATCH_ACCESS_PReturns, as a 3-byte value, the range of times during which batchaccess is permitted for primary days. Each bit set represents a 1-hourperiod, from bit 0 as midnight to 1 a.m. to bit 23 as 11 p.m. tomidnight.The buffer length field in the item descriptor should specify 3 (bytes). UAI$_BATCH_ACCESS_SReturns, as a 3-byte value, the range of times during which batchaccess is permitted for secondary days. Each bit set represents a1-hour period, from bit 0 as midnight to 1 a.m. to bit 23 as 11 p.m. tomidnight.The buffer length field in the item descriptor should specify 3 (bytes). UAI$_BIOLMReturns the buffered I/O count.Because this decimal number is a word in length, the buffer lengthfield in the item descriptor should specify 2 (bytes). UAI$_BYTLMReturns the buffered I/O byte limit.Because the buffered I/O byte limit is a longword decimal number, thebuffer length field in the item descriptor should specify 4 (bytes). UAI$_CLITABLESReturns, as a character string, the name of the user-defined CLI tablefor the account, if any.Because the CLI table name can include up to 31 characters in additionto a size-byte prefix, the buffer length field of the item descriptorshould specify 32 (bytes). UAI$_CPUTIMReturns the maximum CPU time limit (per session) for the process in10-millisecond units.Because the maximum CPU time limit is a longword decimal number, thebuffer length field in the item descriptor should specify 4 (bytes). UAI$_DEFCLIReturns, as an RMS file name component, the name of the commandlanguage interpreter used to execute the specified batch job. The filespecification returned assumes the device name and directory SYS$SYSTEMand the file type .EXE.Because a file name can include up to 31 characters in addition to asize-byte prefix, the buffer length field in the item descriptor shouldspecify 32 (bytes). UAI$_DEFDEVReturns, as a 1- to 31-character string, the name of the default device.Because the device name string can include up to 31 characters inaddition to a size-byte prefix, the buffer length field in the itemdescriptor should specify 32 (bytes). UAI$_DEFDIRReturns, as a 1- to 63-character string, the name of the defaultdirectory.Because the directory name string can include up to 63 characters inaddition to a size-byte prefix, the buffer length field in the itemdescriptor should specify 64 (bytes). UAI$_DEF_PRIVReturns the default privileges for the user.Because the default privileges are returned as a quadword value, thebuffer length field in the item descriptor should specify 8 (bytes). UAI$_DFWSCNTReturns the default working set size in pages (on VAX systems) orpagelets (on Alpha systems).Because the default working set size is a longword decimal number, thebuffer length field in the item descriptor should specify 4 (bytes). UAI$_DIOLMReturns the direct I/O count limit.Because this decimal number is a word in length, the buffer lengthfield in the item descriptor should specify 2 (bytes). UAI$_DIALUP_ACCESS_PReturns, as a 3-byte value, the range of times during which dialupaccess is permitted for primary days. Each bit set represents a 1-hourperiod, from bit 0 as midnight to 1 a.m. to bit 23 as 11 p.m. tomidnight. For each hour the bit is set to 0, access is allowed. Foreach hour the bit is set to 1, access is denied.The buffer length field in the item descriptor should specify 3 (bytes). UAI$_DIALUP_ACCESS_SReturns, as a 3-byte value, the range of times during which dialupaccess is permitted for secondary days. Each bit set represents a1-hour period, from bit 0 as midnight to 1 a.m. to bit 23 as 11 p.m. tomidnight. For each hour the bit is set to 0, access is allowed. Foreach hour the bit is set to 1, access is denied.The buffer length field in the item descriptor should specify 3 (bytes). UAI$_ENCRYPTReturns one of the values shown in the following table, identifying theencryption algorithm for the primary password.Because the encryption algorithm is a byte in length, the buffer lengthfield in the item descriptor should specify 1 (byte). | Symbolic Name | Description | | UAI$C_AD_II | Uses a CRC algorithm and returns a longword hash value. It was used in VAX VMS releases prior to Version 2.0. | | UAI$C_PURDY | Uses a Purdy algorithm over salted input. It expects a blank-padded user name and returns a quadword hash value. This algorithm was used during VAX VMS Version 2.0 field test. | | UAI$C_PURDY_V | Uses the Purdy algorithm over salted input. It expects a variable-length user name and returns a quadword hash value. This algorithm was used in VMS releases prior to Version 5.4. | | UAI$C_PURDY_S | Uses the Purdy algorithm over salted input. It expects a variable-length user name and returns a quadword hash value. This is the current algorithm that the operating system uses for all new password changes. | UAI$_ENCRYPT2Returns one of the following values identifying the encryptionalgorithm for the secondary password: - UAI$C_AD_II
- UAI$C_PURDY
- UAI$C_PURDY_V
- UAI$C_PURDY_S
Because the encryption algorithm is a byte in length, the buffer lengthfield in the item descriptor should specify 1 byte. UAI$_ENQLMReturns the lock queue limit.Because this decimal number is a word in length, the buffer lengthfield in the item descriptor should specify 2 (bytes). UAI$_EXPIRATIONReturns, as a quadword absolute time value, the expiration date andtime of the account.Because the absolute time value is a quadword in length, the bufferlength field in the item descriptor should specify 8 (bytes). UAI$_FILLMReturns the open file limit.Because this decimal number is a word in length, the buffer lengthfield in the item descriptor should specify 2 (bytes). UAI$_FLAGSReturns, as a longword bit vector, the various login flags set for theuser.Each flag is represented by a bit. The $UAIDEF macro defines thefollowing symbolic names for these flags: | Symbolic Name | Description | | UAI$V_AUDIT | All actions are audited. | | UAI$V_AUTOLOGIN | User can only log in to terminals defined by the Automatic Login facility (ALF). | | UAI$V_CAPTIVE | User is restricted to captive account. | | UAI$V_DEFCLI | User is restricted to default command interpreter. | | UAI$V_DISACNT | User account is disabled. Same as /FLAG = DISUSER qualifier in AUTHORIZE. | | UAI$V_DISCTLY | User cannot use Ctrl/Y. | | UAI$V_DISFORCE_PWD_CHANGE | User will not be forced to change expired passwords at login. | | UAI$V_DISIMAGE | User cannot issue the RUN or MCR commands or use the foreign command mechanism in DCL. | | UAI$V_DISMAIL | Announcement of new mail is suppressed. | | UAI$V_DISPWDDIC | Automatic checking of user-selected passwords against the system dictionary is disabled. | | UAI$V_DISPWDHIS | Automatic checking of user-selected passwords against previously used passwords is disabled. | | UAI$V_DISRECONNECT | User cannot reconnect to existing processes. | | UAI$V_DISREPORT | User will not receive last login messages. | | UAI$V_DISWELCOME | User will not receive the login welcome message. | | UAI$V_EXTAUTH | User is considered to be externally authenticated by their external user ID and password, and not by the SYSUAF user ID and password. The SYSUAF record is still used for checking login restrictions and quotas and for creating the user's OpenVMS process profile. | | UAI$V_GENPWD | User is required to use generated passwords. | | UAI$V_LOCKPWD | SET PASSWORD command is disabled. | | UAI$V_MIGRATEPWD | User's SYSUAF password has been set using AUTHORIZE or SYS$SETUAI and is likely to be inconsistent with the user's external user password. If password migration is enabled, the system will attempt to update the external authentication service the next time the user attempts a login. | | UAI$V_NOMAIL | Mail delivery to user is disabled. | | UAI$V_PWD_EXPIRED | Primary password is expired. | | UAI$V_PWD2_EXPIRED | Secondary password is expired. | | UAI$V_RESTRICTED | User is limited to operating under a restricted account. (Refer to the HP OpenVMS Guide to System Security for a description of restricted and captive accounts.) | UAI$_JTQUOTAReturns the initial byte quota with which the jobwide logical nametable is to be created.Because this quota is a longword decimal number, the buffer lengthfield in the item descriptor should specify 4 (bytes). UAI$_LASTLOGIN_IReturns, as a quadword absolute time value, the date of the lastinteractive login.UAI$_LASTLOGIN_NReturns, as a quadword absolute time value, the date of the lastnoninteractive login.UAI$_LGICMDReturns, as an OpenVMS RMS file specification, the name of the defaultlogin command file.Because a file specification can include up to 63 characters inaddition to a size-byte prefix, the buffer length field of the itemdescriptor should specify 64 (bytes). UAI$_LOCAL_ACCESS_PReturns, as a 3-byte value, the range of times during which localinteractive access is permitted for primary days. Each bit setrepresents a 1-hour period, from bit 0 as midnight to 1 a.m. to bit 23as 11 p.m. to midnight. For each hour the bit is set to 0, access isallowed. For each hour the bit is set to 1, access is denied.The buffer length field in the item descriptor should specify 3 (bytes). UAI$_LOCAL_ACCESS_SReturns, as a 3-byte value, the range of times during which batchaccess is permitted for secondary days. Each bit set represents a1-hour period, from bit 0 as midnight to 1 a.m. to bit 23 as 11 p.m. tomidnight. For each hour the bit is set to 0, access is allowed. Foreach hour the bit is set to 1, access is denied.The buffer length field in the item descriptor should specify 3 (bytes). UAI$_LOGFAILSReturns the count of login failures.Because this decimal number is a word in length, the buffer lengthfield in the item descriptor should specify 2 (bytes). UAI$_MAXACCTJOBSReturns the maximum number of batch, interactive, and detachedprocesses that can be active at one time for all users of the sameaccount. The value 0 represents an unlimited number.Because this decimal number is a word in length, the buffer lengthfield in the item descriptor should specify 2 (bytes). UAI$_MAXDETACHReturns the detached process limit. A value of 0 represents anunlimited number.Because this decimal number is a word in length, the buffer lengthfield in the item descriptor should specify 2 (bytes). UAI$_MAXJOBSReturns the active process limit. A value of 0 represents an unlimitednumber.Because this decimal number is a word in length, the buffer lengthfield in the item descriptor should specify 2 (bytes). UAI$_NETWORK_ACCESS_PReturns, as a 3-byte value, the range of times during which networkaccess is permitted for primary days. Each bit set represents a 1-hourperiod, from bit 0 as midnight to 1 a.m. to bit 23 as 11 p.m. tomidnight. For each hour the bit is set to 0, access is allowed. Foreach hour the bit is set to 1, access is denied.The buffer length field in the item descriptor should specify 3 (bytes). UAI$_NETWORK_ACCESS_SReturns, as a 3-byte value, the range of times during which networkaccess is permitted for secondary days. Each bit set represents a1-hour period, from bit 0 as midnight to 1 a.m. to bit 23 as 11 p.m. tomidnight. For each hour the bit is set to 0, access is allowed. Foreach hour the bit is set to 1, access is denied.The buffer length field in the item descriptor should specify 3 (bytes). UAI$_OWNERReturns, as a character string, the name of the owner of the account.Because the owner name can include up to 31 characters in addition to asize-byte prefix, the buffer length field of the item descriptor shouldspecify 32 (bytes). UAI$_PBYTLMReturns the paged buffer I/O byte count limit.Because the paged buffer I/O byte count limit is a longword decimalnumber, the buffer length field in the item descriptor should specify 4(bytes). UAI$_PGFLQUOTAReturns the paging file quota in pages (on VAX systems) or in blocks(on Alpha systems).Because the paging file quota is a longword decimal number, the bufferlength field in the item descriptor should specify 4 (bytes). UAI$_PRCCNTReturns the subprocess creation limit.Because the subprocess creation limit is a longword decimal number, thebuffer length field in the item descriptor should specify 4 (bytes). UAI$_PRIReturns the default base priority in the range 0 through 31.Because this decimal number is a byte in length, the buffer lengthfield in the item descriptor should specify 1 (byte). UAI$_PRIMEDAYSReturns, as a byte bit vector, the primary and secondary days of theweek.Each bit represents a day of the week, with the bit clear representinga primary day and the bit set representing a secondary day. The $UAIDEFmacro defines the following symbolic names for these bits: UAI$V_MONDAY
UAI$V_TUESDAY
UAI$V_WEDNESDAY
UAI$V_THURSDAY
UAI$V_FRIDAY
UAI$V_SATURDAY
UAI$V_SUNDAY UAI$_PRIVReturns, as a quadword value, the names of the privileges the userholds.Because this value is a quadword in length, the buffer length field inthe item descriptor should specify 8 (bytes). UAI$_PWDReturns, as a quadword value, the hashed primary password of the user.Because this value is a quadword in length, the buffer length field inthe item descriptor should specify 8 (bytes). UAI$_PWD_DATEReturns, as a quadword absolute time value, the date of the lastpassword change.Because this value is a quadword in length, the buffer length field inthe item descriptor should specify 8 (bytes). A value of --1 indicates that the password is marked as preexpired. UAI$_PWD_LENGTHReturns the minimum password length.Because this decimal number is a byte in length, the buffer lengthfield in the item descriptor should specify 1 (byte). UAI$_PWD_LIFETIMEReturns, as a quadword delta time value, the password lifetime.Because this value is a quadword in length, the buffer length field inthe item descriptor should specify 8 (bytes). A quadword of 0 means that none of the password mechanisms will takeeffect. UAI$_PWD2Returns, as a quadword value, the hashed secondary password of the user.Because this value is a quadword in length, the buffer length field inthe item descriptor should specify 8 (bytes). UAI$_PWD2_DATEReturns, as a quadword absolute time value, the last date the secondarypassword was changed.Because this value is a quadword in length, the buffer length field inthe item descriptor should specify 8 (bytes). A value of --1 indicates that the password could be marked aspreexpired. UAI$_QUEPRIReturns the maximum job queue priority.Because this decimal number is a byte in length, the buffer lengthfield in the item descriptor should specify 1 (byte). UAI$_REMOTE_ACCESS_PReturns, as a 3-byte value, the range of times during which remoteinteractive access is permitted for primary days. Each bit setrepresents a 1-hour period, from bit 0 as midnight to 1 a.m. to bit 23as 11 p.m. to midnight.The buffer length field in the item descriptor should specify 3 (bytes). UAI$_REMOTE_ACCESS_SReturns, as a 3-byte value, the range of times during which remoteinteractive access is permitted for secondary days. Each bit setrepresents a 1-hour period, from bit 0 as midnight to 1 a.m. to bit 23as 11 p.m. to midnight.The buffer length field in the item descriptor should specify 3 (bytes). UAI$_SALTReturns the random password salt.Because this decimal number is a word in length, the buffer lengthfield in the item descriptor should specify 2 (bytes). UAI$_SHRFILLMReturns the shared file limit.Because this decimal number is a word in length, the buffer lengthfield in the item descriptor should specify 2 (bytes). UAI$_TQCNTReturns the timer queue entry limit.Because this decimal number is a word in length, the buffer lengthfield in the item descriptor should specify 2 (bytes). UAI$_UICReturns, as a longword, the user identification code (UIC). For theformat of the UIC, see the HP OpenVMS Guide to System Security.UAI$_USER_DATAReturns up to 255 bytes of information from the user data area of thesystem user authorization file (SYSUAF).You can read information written to the user data area from previousversions of the operating system as long as the information writtenadheres to the guidelines described in the HP OpenVMS Guide to System Security. UAI$_WSEXTENTReturns the working set extent, in pages (on VAX systems) or pagelets(on Alpha systems), for the user of the specified queue or job.Because the working set extent is a longword decimal number, the bufferlength field in the item descriptor should specify 4 (bytes). UAI$_WSQUOTAReturns the working set quota, in pages (on VAX systems) or pagelets(on Alpha systems), for the specified user.Because this quota is a longword decimal number, the buffer lengthfield in the item descriptor should specify 4 (bytes).
DescriptionThe Get User Authorization Information service returns authorizationinformation about a specified user.The contxt value returned by $GETUAI should never beused as a value to the $SETUAI system service. You examine for a valid login by checking the bits of UAI$V_PWD_EXPIREDand UAI$V_DISUSER, and by doing a comparison of the UAI$_PWD_DATE itemcode against the UAI$_PWD_LIFETIME item code. The UAI$V_PWD_EXPIRED bit is only set by the system when the bitUAI$V_DISFORCE_PWD_CHANGE is set in the user's SYSUAF record and thecomparison between the UAI$_PWD_DATE and UAI$_PWD_LIFETIME indicates apassword is past its valid life. During a normal login when the UAI$V_DISFORCE_PWD_CHANGE bit is notset, the system compares VAI$_PWD_DATE against UAI$_PWD_LIFETIME and,if expired, forces the user to change the password. With thisconfiguration, the UAI$V_PWD_EXPIRED bit is not set. During a normal login when the VAI$V_DISFORCE_PWD_EXPIRED is set, thesystem compares UAI$_PWD_DATE against UAI$_PWD_LIFETIME and, ifexpired, sets the UAI$_PWD_EXPIRED bit and notifies the user to changethe now-expired password. In this case, the user is not forced tochange the password. Required Access or Privileges
Use the following list to determine the privileges required to use the$GETUAI service: - BYPASS or SYSPRV---Allows access to any record in the user authorization file (UAF).
- GRPPRV---Allows access to any record in the UAF whose UIC group matches that of the requester.
- No privilege---Allows access to any UAF record whose UIC matches that of the requester.
You need read access to the UAF to look up any information other than your own. Required Quota
None Related Services
$SETUAI
Condition Values Returned | SS$_NORMAL | The service completed successfully. | | SS$_ACCVIO | The item list or input buffer cannot be read by the caller; or the return length buffer, output buffer, or status block cannot be written by the caller. | | SS$_BADPARAM | The function code is invalid; the item list contains an invalid item code; a buffer descriptor has an invalid length; or the reserved parameter has a nonzero value. | | SS$_NOGRPPRV | The user does not have the privileges required to examine the authorization information for other members of the UIC group. | | SS$_NOSYSPRV | The user does not have the privileges required to examine the authorization information associated with the user or for users outside of the user's UIC group. | | RMS$_RSZ | The UAF record is smaller than required; the caller's SYSUAF is probably corrupt. |
This service can also return OpenVMS RMS status codes associated withoperations on indexed files. For example, an inquiry about anonexistent account returns RMS$_RNF, record not found status. For adescription of RMS status codes that are returned by this service,refer to the OpenVMS Record Management Services Reference Manual.
$GETUTCReturns the current time in 128-bit UTC format.On Alpha systems, this service accepts 64-bit addresses.
FormatSYS$GETUTC utcadr
C Prototypeint sys$getutc (unsigned int *utcadr [4]);
Argumentsutcadr
| OpenVMS usage: | coordinated universal time | | type: | utc_date_time | | access: | write only | | mechanism: | by 32- or 64-bit reference (Alpha) | | mechanism: | by 32-bit reference (VAX) |
The 128-bit time value to be returned.
DescriptionThe Get UTC Time service returns the current system time in 128-bit UTCformat. System time is updated every 10 milliseconds.On Alpha systems, the frequency at which system time is updated varies,depending on the clock frequency of the Alpha processor. Required Access or Privileges
None Required Quota
None Related Services
$ASCUTC, $BINUTC, $NUMUTC, $TIMCON
Condition Values Returned | SS$_NORMAL | The service completed successfully. | | SS$_ACCVIO | The argument was not accessible for write in the mode of the caller. |
$GET_ALIGN_FAULT_DATA (Alpha Only)On Alpha systems, obtains data from the user image alignment faultbuffer if buffered user alignment fault data reporting has been enabled.This service accepts 64-bit addresses.
FormatSYS$GET_ALIGN_FAULT_DATA buffer ,buffer_size ,return_size
C Prototypeint sys$get_align_fault_data (void *buffer, int buffer_size, int*return_size);
Argumentsbuffer
| OpenVMS usage: | address | | type: | longword (unsigned) | | access: | read/write | | mechanism: | by 32- or 64-bit reference |
The user buffer in which the alignment fault data is to be stored. Thebuffer is the 32- or 64-bit address of this userbuffer.buffer_size
| OpenVMS usage: | byte count | | type: | longword (signed) | | access: | read | | mechanism: | by value |
The size, in bytes, of the buffer specified by thebuffer argument.return_size
| OpenVMS usage: | longword_signed | | type: | longword (signed) | | access: | write | | mechanism: | by 32- or 64-bit reference |
The amount of data, in bytes, stored in the buffer. Thereturn_size argument is the 32- or 64-bit address of anaturally aligned longword into which the service returns the size ofthe buffer. The return_size is set to 0 if there is nodata in the buffer.
DescriptionThe Get Alignment Fault Data service obtains data from the user imagealignment fault buffer if buffered user alignment fault data reportinghas been enabled.When buffered user alignment fault data reporting is enabled, theoperating system writes each alignment fault into a user-definedbuffer. The user must poll this buffer periodically to read the data. The user must call the $START_ALIGN_FAULT_REPORT service to enablebuffered user alignment fault data reporting. For more information about buffered user alignment fault datareporting, see the $START_ALIGN_FAULT_REPORT system service. Required Access or Privileges
None Required Quota
None Related Services
$GET_SYS_ALIGN_FAULT_DATA, $INIT_SYS_ALIGN_FAULT_REPORT,$PERM_DIS_ALIGN_FAULT_REPORT, $PERM_REPORT_ALIGN_FAULT,$START_ALIGN_FAULT_REPORT, $STOP_ALIGN_FAULT_REPORT,$STOP_SYS_ALIGN_FAULT_REPORT
Condition Values Returned | SS$_NORMAL | The service completed successfully. | | SS$_ACCVIO | The buffer named in the buffer argument is not accessible. | | SS$_AFR_NOT_ENABLED | Alignment fault reporting has not been enabled. | | SS$_BADPARAM | The buffer size is smaller than the minimum defined by the AFR$K_USER_LENGTH
symbol. |
$GET_ARITH_EXCEPTION (Alpha Only)On Alpha systems, returns information about the exception context for agiven arithmetic exception.
FormatSYS$GET_ARITH_EXCEPTION sigarg ,mcharg ,buffer
C Prototypeint sys$get_arith_exception (void *sigarg, void *mcharg, void *buffer);
Argumentssigarg
| OpenVMS usage: | signal array | | type: | vector_longword_signed | | access: | read only | | mechanism: | by reference |
Address of the signal array for the given arithmetic exception.mcharg
| OpenVMS usage: | mech array | | type: | vector_quadword_unsigned | | access: | read only | | mechanism: | by reference |
Address of the mechanism array for the given arithmetic exception.buffer
| OpenVMS usage: | vector_quadword | | type: | vector_quadword_unsigned | | access: | write only | | mechanism: | by descriptor |
Four-quadword buffer to receive additional exception context. Thebuffer argument is the address of a descriptor thatpoints to this buffer.
DescriptionThe Get Arithmetic Exception Information service returns, to the bufferspecified by the buffer argument, the followinginformation for a given arithmetic exception in an array of quadwords: - First quadword, the PC of the triggering instruction in the trap shadow
- Second quadword, a copy of the triggering instruction
- Third quadword, the exception summary
- Fourth quadword, the register write mask
Required Access or Privilege
None Required Quota
None
Condition Values Returned | SS$_NORMAL | The service completed successfully. | | SS$_ACCVIO | The specified buffer cannot be written. | | SS$_BADBUFLEN | The specified buffer length is invalid or out of range. |
$GET_DEFAULT_TRANSReturns the default transaction of the calling process.
FormatSYS$GET_DEFAULT_TRANS tid
C Prototypeint sys$get_default_trans (unsigned int tid [4]);
Argumentstid
| OpenVMS usage: | trans_id | | type: | octaword (unsigned) | | access: | write only | | mechanism: | by reference |
Address of an octaword in which the identifier (TID) of the defaulttransaction of the calling process is returned.
DescriptionA precondition for the successful completion of $GET_DEFAULT_TRANS isthat the calling process must have a default transaction.$GET_DEFAULT_TRANS may fail for various reasons, including: - The precondition was not met.
- The default transaction was being changed at the time of the call.
The postcondition on successful completion of $GET_DEFAULT_TRANS isdescribed in Table SYS-44: Required Privileges
None Required Quotas
None Related Services
$ABORT_TRANS, $ABORT_TRANSW, $ACK_EVENT, $ADD_BRANCH, $ADD_BRANCHW,$CREATE_UID, $DECLARE_RM, $DECLARE_RMW, $END_BRANCH, $END_BRANCHW,$END_TRANS, $END_TRANSW, $FORGET_RM, $FORGET_RMW, $GETDTI, $GETDTIW,$JOIN_RM, $JOIN_RMW, $SETDTI, $SETDTIW, $SET_DEFAULT_TRANS,$SET_DEFAULT_TRANSW, $START_BRANCH, $START_BRANCHW, $START_TRANS,$START_TRANSW, $TRANS_EVENT, $TRANS_EVENTW
Condition Values Returned | SS$_NORMAL | The request was successful. | | SS$_INSFARGS | A required argument was missing. | | SS$_INSFMEM | There was insufficient system dynamic memory for the operation. | | SS$_NOCURTID | The calling process did not have a default transaction. | | SS$_WRONGSTATE | The default transaction was being changed at the time of the call. |
$GET_GALAXY_LOCK_INFO (Alpha Only)Returns "interesting" fields from the specified lock.Note that this system service is supported only in an OpenVMS AlphaGalaxy environment. For more information about programming with OpenVMSGalaxy system services, refer to the HP OpenVMS Alpha Partitioning and Galaxy Guide.
FormatSYS$GET_GALAXY_LOCK_INFO handle ,name ,timeout ,size ,ipl ,rank ,flags[,name_length]
C Prototypeint sys$get_galaxy_lock_info (unsigned __int64 lock_handle, char *name,unsigned int *timeout, unsigned int *size, unsigned int *ipl, unsignedint *rank, unsigned short int *flags unsigned short int *name_length);
Argumentshandle
| OpenVMS usage: | handle for the galaxy lock | | type: | quadword (unsigned) | | access: | read | | mechanism: | input by value |
The 64-bit lock handle that identifies the lock on which to returninformation. This value is returned by SYS$CREATE_GALAXY_LOCK.name
| OpenVMS usage: | address | | type: | zero-terminated string | | access: | write | | mechanism: | output by reference |
Pointer to a buffer. This buffer must be large enough to receive thename of the lock. Locks names are zero-terminated strings with amaximum size of 16 bytes.timeout
| OpenVMS usage: | address | | type: | longword (unsigned) | | access: | write | | mechanism: | output by reference |
Pointer to a longword. The value returned is the timeout value of thelock.size
| OpenVMS usage: | address | | type: | longword (unsigned) | | access: | write | | mechanism: | output by reference |
Pointer to a longword. The value returned is the size of the lock inbytes.ipl
| OpenVMS usage: | address | | type: | longword (unsigned) | | access: | write | | mechanism: | output by reference |
Pointer to a longword. The value returned is the IPL of the lock.rank
| OpenVMS usage: | address | | type: | longword (unsigned) | | access: | write | | mechanism: | output by reference |
Pointer to a longword. The value returned is the rank of the lock.flags
| OpenVMS usage: | address | | type: | word (unsigned) | | access: | write | | mechanism: | output by reference |
Pointer to a word. The value returned is the word mask of lock flags.name_length
| OpenVMS usage: | address | | type: | word (unsigned) | | access: | write | | mechanism: | output by reference |
Length of the string returned in the name argument.
DescriptionThis service returns all "interesting" fields from the specified lock.See the $CREATE_GALAXY_LOCK service for detailed information regardingthese values.Required Access or Privileges
Read access to lock. Required Quota
None Related Services
$ACQUIRE_GALAXY_LOCK, $CREATE_GALAXY_LOCK, $CREATE_GALAXY_LOCK_TABLE,$DELETE_GALAXY_LOCK, $DELETE_GALAXY_LOCK_TABLE, $GET_GALAXY_LOCK_SIZE,$RELEASE_GALAXY_LOCK
Condition Values Returned | SS$_NORMAL | Normal completion. | | SS$_IVLOCKID | Invalid lock id. | | SS$_IVLOCKTBL | Invalid lock table. |
$GET_GALAXY_LOCK_SIZE (Alpha Only)Returns the minimum and maximum size of an OpenVMS Galaxy lock.Note that this system service is supported only in an OpenVMS AlphaGalaxy environment. For more information about programming with OpenVMS Galaxy systemservices, refer to the HP OpenVMS Alpha Partitioning and Galaxy Guide.
FormatSYS$GET_GALAXY_LOCK_SIZE min_size ,max_size
C Prototypeint sys$get_galaxy_lock_size (unsigned int *min_size, unsigned int*max_size);
Argumentsmin_size
| OpenVMS usage: | address | | type: | longword (unsigned) | | access: | write | | mechanism: | output by reference |
Pointer to a longword. The value returned is minimum legal size of agalaxy lock structure.max_size
| OpenVMS usage: | address | | type: | longword (unsigned) | | access: | write | | mechanism: | output by reference |
Pointer to a longword. The value returned is maximum legal size of agalaxy lock structure.
DescriptionThis service returns the minimum and maximum size of an OpenVMS Galaxylock. If a lock is created with the maximum size, the locking serviceswill record acquire and release information in the lock.The lock sizes can be used to determine the value of thesection_size parameter to the$CREATE_GALAXY_LOCK_TABLE service. Required Access or Privileges
Read access to lock. Required Quota
None Related Services
$ACQUIRE_GALAXY_LOCK, $CREATE_GALAXY_LOCK, $CREATE_GALAXY_LOCK_TABLE,$DELETE_GALAXY_LOCK, $DELETE_GALAXY_LOCK_TABLE, $GET_GALAXY_LOCK_INFO,$RELEASE_GALAXY_LOCK
Condition Values Returned | SS$_NORMAL | Normal completion. |
$GET_REGION_INFO (Alpha Only)On Alpha systems, gets information about a specified virtual region.This service accepts 64-bit addresses.
FormatSYS$GET_REGION_INFO function_code ,region_id_64 ,start_va_64 ,nullarg,buffer_length ,buffer_address_64 ,return_length_64
C Prototypeint sys$get_region_info (unsigned int function_code, struct _generic_64*region_id_64, void *start_va_64, void *reserved, unsigned intbuffer_length, void *buffer_address_64, unsigned int *return_length_64);
Argumentsfunction_code
| OpenVMS usage: | function code | | type: | longword (unsigned) | | access: | read only | | mechanism: | by value |
Function code specifying how the information you are requesting shouldbe looked up. All function codes return region summary information inthe return buffer in the format of the Region Summary Buffer. TheRegion Summary Buffer format is shown in the table in thebuffer_address_64 argument.If less buffer space is specified than the length of the Region SummaryBuffer, only the amount of information requested is returned. If morebuffer space is specified than the length of the Region Summary Buffer,the service will fill in the buffer. The return length will reflect theamount of useful information written to the buffer, the size of theRegion Summary Buffer. The file VADEF.H in SYS$STARLET_C.TLB and the $VADEF macro inSTARLET.MLB define a symbolic name for each function code. The following function codes are defined: | Symbolic Name | Description | | VA$_REGSUM_BY_ID | Return the region summary information for the region whose ID is specified in the region_id_64 argument. | | VA$_REGSUM_BY_VA | Return the region summary information for the region that contains the virtual address specified in the start_va_64 argument. | | VA$_NEXT_REGSUM_BY_VA | Return the region summary information for the region containing the starting address. If the starting address is not in a region, return the region summary information for the next region with a starting address higher than the specified address. Note: For the VA$_NEXT_REGSUM_BY_VA function, OpenVMS checks for a start_va_64 argument in the inaccessible address range in P2 space. If it finds one, OpenVMS adjusts the address to account for the discontinuity. For more information about the layout of the 64-bit virtual address space, refer to the OpenVMS Programming Concepts Manual. This function code can be used for wildcard operations. See the description of the start_va_64 argument for information on how to program a wildcard operation on regions. | region_id_64
| OpenVMS usage: | region identifier | | type: | quadword (unsigned) | | access: | read only | | mechanism: | by 32- or 64-bit reference |
The region ID associated with the region about which information isrequested. This argument is read only if the function codeVA$_REGSUM_BY_ID is specified.The file VADEF.H in SYS$STARLET_C.TLB and the $VADEF macro inSTARLET.MLB define a symbolic name for each of the three defaultregions in P0, P1, and P2 space. The following region IDs are defined: | Symbol | Region | | VA$C_P0 | Program region | | VA$C_P1 | Control region | | VA$C_P2 | 64-bit program region | Other region IDs, as returned by the $CREATE_REGION_64 service, can bespecified. start_va_64
| OpenVMS usage: | input address | | type: | quadword address | | access: | read only | | mechanism: | by value |
Virtual address associated with region about which information isrequested. This argument is read only if thefunction_code argument is VA$_REGSUM_BY_VA orVA$_NEXT_REGSUM_BY_VA.If the function_code argument is VA$_REGSUM_BY_VA,this argument is a virtual address within the region about which youare requesting information. To perform a wildcard search on all regions, specifyVA$_NEXT_REGSUM_BY_VA as the function code and begin with thestart_va_64 argument specified as -1. For subsequentcalls, specify start_va_64 as the sum of the previousregion's start address and length. Call the $GET_REGION_INFO service ina loop until the condition SS$_NOMOREREG is returned. Note
Before performing the lookup function, OpenVMS sign-extends the 64-bitstarting address so that it represents a properly formed virtualaddress for the CPU. |
nullarg
| OpenVMS usage: | null_arg | | type: | longword (unsigned) | | access: | read only | | mechanism: | by value |
Placeholding argument reserved to HP.buffer_length
| OpenVMS usage: | longword_unsigned | | type: | longword (unsigned) | | access: | read only | | mechanism: | by value |
Length of the buffer into which information is returned.buffer_address_64
| OpenVMS usage: | varying_arg | | type: | unspecified | | access: | write only | | mechanism: | by 32- or 64-bit reference |
The 32- or 64-bit virtual address of a quadword-aligned buffer intowhich to return information if the buffer_lengthargument is nonzero.This argument is ignored if the buffer_length argumentis zero. Table SYS-45 shows the format of the Region Summary Buffer: Table SYS-45 Region Summary Buffer Format | Field name | Meaning | Field Size (Bytes) | Field Offset (Decimal) | | VA$L_FLAGS | Flags used when region was created | 4 | 8 | | VA$L_REGION_PROTECT | Create and owner mode of region | 4 | 12 | | VA$Q_REGION_ID | Region identifier | 8 | 0 | | VA$PQ_START_VA | Starting (lowest) virtual address of region | 8 | 16 | | VA$Q_REGION_SIZE | Total length of region | 8 | 24 | | VA$PQ_FIRST_FREE_VA | First free virtual address in region | 8 | 32 | | VA$C_REGSUM_LENGTH | Length of Region Summary Buffer | constant | 40 | The file VADEF.H in SYS$STARLET_C.TLB and the $VADEF MACRO inSTARLET.MLB define the REGSUM structure. return_length_64
| OpenVMS usage: | longword_unsigned | | type: | longword (unsigned) | | access: | write only | | mechanism: | by 32- or 64-bit reference |
The 32- or 64-bit virtual address of a naturally aligned longword intowhich the service returns the length of the information in bytes.
DescriptionThe Get Information About a Specified Virtual Region service is akernel mode service that can be called from any mode. This service getsthe requested information about the specified region or the next regionin a wildcard search. If the returned value of this service is not asuccessful condition value, a value cannot be returned in thememory locations pointed to by the buffer_address_64or return_length_64 arguments.Required Privileges
None Required Quota
None Related Services
$CREATE_REGION_64, $DELETE_REGION_64
Condition Values Returned | SS$_NORMAL | The service completed successfully. | | SS$_ACCVIO | The buffer_address_64 argument or the return_length_64 argument cannot be written by the caller. | | SS$_BADPARAM | Unrecognized function code. | | SS$_IVREGID | Invalid region ID specified in conjunction with the VA$_REGSUM_BY_ID function code. | | SS$_NOMOREREG | No region at a higher address than specified in the start_va_64 argument, which was specified in conjunction with the wildcard function code VA$_NEXT_REGSUM_BY_VA. | | SS$_PAGNOTINREG | The value specified in the start_va_64 argument is not within a region and was specified in conjunction with the function code VA$_REGSUM_BY_VA. |
$GET_SECURITYRetrieves the security characteristics of an object.
FormatSYS$GET_SECURITY [clsnam] ,[objnam] ,[objhan] ,[flags] ,[itmlst],[contxt] ,[acmode]
C Prototypeint sys$get_security (void *clsnam, void *objnam, unsigned int *objhan,unsigned int flags, void *itmlst, unsigned int *contxt, unsigned int*acmode);
Argumentsclsnam
| OpenVMS usage: | char_string | | type: | character-coded text string | | access: | read only | | mechanism: | by descriptor |
Name of the object class. The clsnam argument is theaddress of a descriptor pointing to a string containing the name of theobject class.The following is a list of protected object class names: CAPABILITY
COMMON_EVENT_CLUSTER
DEVICE
FILE
GLXSYS_GLOBAL_SECTION
GLXGRP_GLOBAL_SECTION
GROUP_GLOBAL_SECTION
ICC_ASSOCIATION
LOGICAL_NAME_TABLE
QUEUE
RESOURCE_DOMAIN
SECURITY_CLASS
SYSTEM_GLOBAL_SECTION
VOLUME objnam
| OpenVMS usage: | char_string | | type: | character-coded text string | | access: | read only | | mechanism: | by descriptor |
Name of the protected object whose associated security profile is goingto be retrieved. The objnam argument is the address ofa descriptor pointing to a string containing the name of the protectedobject.The format of an object name is class specific. The following tablelists object names and describes their formats: | Object Class | Object Name Format | | CAPABILITY | A character string. Currently, the only capability object is VECTOR. | | COMMON_EVENT_CLUSTER | Name of the event flag cluster, as defined in the Associate Common Event Flag Cluster ($ASCEFC) system service. | | DEVICE | Standard device specification, described in the OpenVMS User's Manual. | | FILE | Standard file specification, described in the OpenVMS User's Manual. | | GROUP_GLOBAL_SECTION | Section name, as defined in the Create and Map Section ($CRMPSC) system service. | | ICC_ASSOCIATION | ICC security object name node::association_name. The special node name, ICC$::, refers to entries in the clusterwide registry. For registry entries, the Access Access Type does not apply. | | LOGICAL_NAME_TABLE | Table name, as defined in the Create Logical Name Table ($CRELNT) system service. | | QUEUE | Standard queue name, as described in the Send to Job Controller ($SNDJBC) system service. | | RESOURCE_DOMAIN | An identifier or octal string enclosed in brackets. | | SECURITY_CLASS | Any class name shown in column 1, or a class name followed by a period (.) and the template name. Use the DCL command SHOW SECURITY to display possible template names. | | SYSTEM_GLOBAL_SECTION | Section name, as defined in the Create and Map Section ($CRMPSC) system service. | | VOLUME | Volume name or name of the device on which the volume is mounted. | objhan
| OpenVMS usage: | object_handle | | type: | longword (unsigned) | | access: | read only | | mechanism: | by reference |
Data structure identifying the object whose associated characteristicsare going to be retrieved. The objhan argument is anaddress of a longword containing the object handle. You can use theobjhan argument as an alternative to theobjnam argument; for example, channel number clearlyspecifies the file open on the channel and can serve as an objecthandle.The following table shows the format of the object classes: | Object Class | Object Handle Format | | COMMON_EVENT_CLUSTER | Event flag number | | DEVICE | Channel number | | FILE | Channel number | | RESOURCE_DOMAIN | Resource domain identifier | | VOLUME | Channel number | flags
| OpenVMS usage: | flags | | type: | mask_longword | | access: | read only | | mechanism: | by value |
Mask specifying processing options. The flags argumentis a longword bit vector wherein a bit, when set, specifies theprocessing option. The flags argument requires thecontxt argument.The following table describes each flag: | Symbolic Name | Description | | OSS$M_RELCTX | Release the context structure at the completion of this request. | | OSS$M_WLOCK | Maintain a write lock on the security profile at the completion of this request. $GET_SECURITY ignores the flag if the context has already been established. | These symbolic names are defined in the $OSSDEF macro. You constructthe flags argument by specifying the symbolic names ofeach flag. itmlst
| OpenVMS usage: | item_list_3 | | type: | longword (unsigned) | | access: | read only | | mechanism: | by reference |
Item list specifying which information about the process or processesis to be returned. The itmlst argument is the addressof a list of item descriptors, each of which describes an item ofinformation. The list of item descriptors is terminated by a longwordof 0.With the item list, the user retrieves the protected object'scharacteristics. The user defines which security characteristics toretrieve. If this argument is not present, only theflags argument is processed. Without theitmlst argument, you can only manipulate thesecurity profile lock or release contxt resources. The following diagram depicts a single item descriptor:
The following table describes the item descriptor fields: | Descriptor Field | Definition | | Buffer length | A word containing an integer specifying the length (in bytes) of the buffer in which $GET_SECURITY is to write the information. The length of the buffer needed depends on the item code specified in the item code field of the item descriptor. If the value of buffer length is too small, $GET_SECURITY truncates the data. | | Item code | A word containing a symbolic code specifying the item of information that $GET_SECURITY is to return. The $OSSDEF macro defines these codes. A description of each item code is given in the Item Codes section. | | Buffer address | A longword containing the address of the buffer in which $GET_SECURITY is to write the information. | | Return length address | A longword containing the address of a word in which $GET_SECURITY writes the length (in bytes) of the information it actually returns. | contxt
| OpenVMS usage: | context | | type: | longword (unsigned) | | access: | modify | | mechanism: | by reference |
Value used to maintain the processing context when dealing with asingle protected object across multiple $GET_SECURITY/$SET_SECURITYcalls. Whenever the context value is nonzero, the class name, objectname, or object handle arguments are disregarded. An input value of 0indicates that a new context should be established.Because an active context block consumes process memory, be sure torelease the context block by setting the RELCTX flag when the profileprocessing is complete. $GET_SECURITY sets the context argument to 0once the context is released. acmode
| OpenVMS usage: | access_mode | | type: | longword (unsigned) | | access: | read only | | mechanism: | by reference |
Access mode to be used in the object protection check. Theacmode argument is the address of a longwordcontaining the access mode. The acmode argumentdefaults to kernel mode; however, the system comparesacmode with the caller's access mode and uses theleast privileged mode. The access modes are defined in the system macro$PSLDEF library. HP recommends that this argument be omitted (passed aszero).Item Codes The following table provides a summary of item codes thatare valid in an item descriptor in the itmlstargument. Complete descriptions of each item code are provided afterthe table. | Item Identifier | Description | | OSS$_ACCESS_NAMES | Returns access bitname translation table for the class. | | OSS$_ACCESS_NAMES_LENGTH | Returns the size (in bytes) of the access bitname translation table. | | OSS$_ACL_FIND_ENTRY | Locates an access control entry (ACE). | | OSS$_ACL_FIND_NEXT | Positions to the next ACE. | | OSS$_ACL_FIND_TYPE | Locates an ACE of specified type. | | OSS$_ACL_GRANT_ACE | Locates an ACE that either grants or denies access. | | OSS$_ACL_LENGTH | Returns the length of the access control list (ACL). | | OSS$_ACL_POSITION_BOTTOM | Sets a marker that points to the end of the ACL. | | OSS$_ACL_POSITION_TOP | Sets a marker that points to the beginning of the ACL. | | OSS$_ACL_READ | Reads the entire ACL. | | OSS$_ACL_READ_ENTRY | Reads an ACE. | | OSS$_CLASS_NAME | Returns the full object class name. | | OSS$_FIRST_TEMPLATE | Returns the name of the first template profile of a Security_Class object. | | OSS$_NEXT_OBJECT | Returns the name of the next Security_Class object. | | OSS$_NEXT_TEMPLATE | Returns the name of the next template profile of a Security_Class object. | | OSS$_OBJECT_NAME | Returns the name of the object. The FILE class does not return an object name. | | OSS$_OWNER | Returns the UIC or general identifier of the object's owner. | | OSS$_PROTECTION | Returns the protection code of the object. | OSS$_ACCESS_NAMESReturns the access name translation table in the buffer pointed to bythe buffer address field of the item descriptor.The access name translation table is a 32-quadword vector followed by avariable section containing the access names. Each bit in the vectorrepresents a single access type. The contents of the quadword is astring descriptor that corresponds to the ASCII bitname string.Undefined access types have zero-length names. The return length, ifpresent, returns the length of the table. OSS$_ACCESS_NAMES_LENGTHReturns the length of the access name translation table.OSS$_ACL_FIND_ENTRYLocates an ACE pointed to by the buffer address. OSS$_ACL_FIND_ENTRYsets the position within the ACL for succeeding ACL operations; forexample, for a deletion or modification of the ACE. If the bufferaddress is 0, it returns SS$_ACCVIO.OSS$_ACL_FIND_NEXTAdvances the current position to the next ACE in the ACL.OSS$_ACL_FIND_TYPEReturns an ACE of a particular type if there is one in the bufferpointed to by the buffer address. OSS$_ACL_FIND_TYPE sets the positionwithin the ACL for succeeding ACL operations. If the buffer address is0, it returns SS$_ACCVIO.OSS$_ACL_GRANT_ACEReturns the ACE in the object's ACL that grants or denies the useraccess to that object. OSS$_ACL_GRANT_ACE returns the ACE found in thebuffer pointed to by the buffer address.OSS$_ACL_LENGTHReturns the size (in bytes) of the object's ACL. The buffer addressfield points to a longword that receives the size.OSS$_ACL_POSITION_BOTTOMSets the ACL position to point to the bottom of the ACL.OSS$_ACL_POSITION_TOPSets the ACL position to point to the top of the ACL.OSS$_ACL_READReturns the portion of the object's ACL to the buffer pointed to by thebuffer address.OSS$_ACL_READ_ENTRYReads the ACE pointed to by the buffer address.OSS$_CLASS_NAMEReturns the full object class name.OSS$_FIRST_TEMPLATEReturns the name of the first template profile for the object named inthe objnam argument. This item code is valid only forsecurity class objects. If the clsnam is notSecurity_Class, SS$_INVCLSITM is returned.OSS$_NEXT_OBJECTReturns the name of the next object. A return length of 0 indicates theend of the list. This item code is valid only for security classobjects. If the clsnam is not Security_Class,SS$_INVCLSITM is returned.OSS$_NEXT_TEMPLATEReturns the name of the next template. This item code allows you tostep through a list of an object's templates. A return length of 0indicates the end of the list. This item code is valid only forsecurity class objects. If the clsnam is notSecurity_Class, SS$_INVCLSITM is returned.OSS_OBJECT_NAMEReturns the name of the object.OSS$_OWNERReturns the owner of the object.OSS$_PROTECTIONReturns the protection code of the object.
DescriptionThe Get Security service returns information about securitycharacteristics of a selected object. Security characteristics includesuch information as the protection code, the owner, and the accesscontrol list (ACL). The security management services, $GET_SECURITY and$SET_SECURITY, maintain a single master copy of a profile for everysecurity object in an OpenVMS Cluster environment. They also ensurethat only one process at a time can modify an object's security profile.There are different ways of identifying which protected object$GET_SECURITY should process: - Whenever the contxt argument has a nonzero value, $GET_SECURITY uses the context to select the object and ignores the class name, object name, and object handle.
- With some types of objects, such as a file or a device, it is possible to select an object on the basis of its objhan and clsnam values.
- If neither a nonzero contxt argument nor an objhan argument is provided, $GET_SECURITY uses an object's class name (clsnam) and object name (objnam) to select the object.
When you call $GET_SECURITY, the service selects the specifiedprotected object and fetches a local copy of the object's securityprofile. The context for a security management operation can be establishedthrough either $GET_SECURITY or $SET_SECURITY. Whenever the context isset by one service, the other service can use it, provided thenecessary locks are being held. If you intend to modify the profile,you must set the write lock flag (OSS$M_WLOCK) when you establish thecontext. There are many situations in which the contxt argumentis essential. By establishing a context for an ACL operation, forexample, a caller can retain an ACL position across calls to$GET_SECURITY so that a set of ACEs can be read and modifiedsequentially. A security context is released by a call to $SET_SECURITYor $GET_SECURITY that sets the OSS$M_RELCTX flag. Once the context isreleased, the user-supplied context longword is set to 0. Required Access or Privileges
Read or control access to the object is required. Required Quota
None Related Services
$SET_SECURITY
Condition Values Returned | SS$_NORMAL | The service completed successfully. | | SS$_ACCVIO | The parameter cannot be read and the buffer cannot be written. | | SS$_BADPARAM | You specified an invalid object, attribute code, or item size. | | SS$_INSFARG | The clsnam and objnam arguments are not specified, the clsnam and objhan arguments are not specified, or the contxt argument is not specified. | | SS$_INVCLSITM | The item code that you specified is not supported for the class. | | SS$_NOCLASS | The named security class does not exist. | | SS$_OBJLOCKED | The selected object is currently write locked. |
$GET_SYS_ALIGN_FAULT_DATA (Alpha Only)On Alpha systems, obtains data from the system alignment fault bufferif buffered system alignment fault data reporting has been enabled.This service accepts 64-bit addresses.
FormatSYS$GET_SYS_ALIGN_FAULT_DATA buffer ,buffer_size ,return_size
C Prototypeint sys$get_sys_align_fault_data (void *buffer, int buffer_size, int*return_size);
Argumentsbuffer
| OpenVMS usage: | address | | type: | longword (unsigned) | | access: | read/write | | mechanism: | by 32- or 64-bit reference |
The user buffer in which the alignment fault data is to be stored. Thebuffer argument is the 32- or 64-bit virtual addressof this buffer.buffer_size
| OpenVMS usage: | byte count | | type: | longword (signed) | | access: | read | | mechanism: | by value |
The size, in bytes, of the buffer specified by thebuffer argument.return_size
| OpenVMS usage: | longword_signed | | type: | longword (signed) | | access: | write | | mechanism: | by 32- or 64-bit reference |
The amount of data, in bytes, stored in the buffer. Thereturn_size argument is the 32- or 64-bit virtualaddress of a naturally aligned longword into which the service returnsthe amount of data, in bytes, stored in the buffer. Thereturn_size argument is set to 0 if there is no datain the buffer.
DescriptionThe Get System Alignment Fault Data service obtains data from thesystem alignment fault buffer if buffered system alignment fault datareporting has been enabled.When buffered system alignment fault data reporting is enabled, theoperating system writes each alignment fault into a system-allocatedbuffer. The user must poll this buffer periodically to read the data. The user must call the $INIT_SYS_ALIGN_FAULT_REPORT service to enablebuffered system alignment fault data reporting. For more information,see the $INIT_SYS_ALIGN_FAULT_REPORT service. Required Access or Privileges
CMKRNL privilege is required. Required Quota
None Related Services
$GET_ALIGN_FAULT_DATA, $INIT_SYS_ALIGN_FAULT_REPORT,$PERM_DIS_ALIGN_FAULT_REPORT, $PERM_REPORT_ALIGN_FAULT,$START_ALIGN_FAULT_REPORT, $STOP_ALIGN_FAULT_REPORT,$STOP_SYS_ALIGN_FAULT_REPORT
Condition Values Returned | SS$_NORMAL | The service completed successfully. | | SS$_ACCVIO | The buffer named in the buffer argument is not accessible. | | SS$_AFR_NOT_ENABLED | Alignment fault reporting has not been enabled. | | SS$_BADPARAM | The buffer size is smaller than the minimum defined by the AFR$K_VMS_LENGTH or the AFR$K_EXTENDED_LENGTH symbol. |
$GET_USER_CAPABILITY (Alpha Only)On Alpha systems, reserves a user capability, indicating to otherprocesses that the resource is in use.This service accepts 64-bit addresses.
FormatSYS$GET_USER_CAPABILITY cap_num [,select_num] [,select_mask][,prev_mask] [,flags]
C Prototypeint sys$get_user_capability (*cap_num, int *select_num, struct_generic_64 *select_mask, struct _generic_64 *prev_mask, struct_generic_64 *flags);
Argumentscap_num
| OpenVMS usage: | longword | | type: | longword (unsigned) | | access: | read only | | mechanism: | by 32- or 64-bit reference |
Capability number to be reserved by the calling kernel thread. Thisnumber can range from 1 to 16 for an explicit request, or the symbolicconstant CAP$K_GET_FREE_CAP can be specified to get the next availableuser capability. The cap_num argument is the 32- or64-bit address of the longword containing the user capability number orsymbolic constant.select_num
| OpenVMS usage: | longword | | type: | longword (unsigned) | | access: | write only | | mechanism: | by 32- or 64-bit reference |
The number of the user capability selected by the service call. Theselect_num argument is the 32- or 64-bit address of alongword into which the system writes the user capability number. Foran explicit numeric request, the value returned in this longword willmatch that specified in cap_num; otherwise, this cellcontains the next available user capability.select_mask
| OpenVMS usage: | mask_quadword | | type: | quadword (unsigned) | | access: | write only | | mechanism: | by 32- or 64-bit reference |
A quadword bit mask with a single bit position set, reflecting the usercapability selected by the service. The select_maskargument is the 32- or 64-bit address of a quadword into which thesystem writes the selected user capability bit mask. This bit mask isthe most efficient method for indicating the reserved user capabilitywith the $CPU_CAPABILITIES and $PROCESS_CAPABILITIES services.prev_mask
| OpenVMS usage: | mask_quadword | | type: | quadword (unsigned) | | access: | write only | | mechanism: | by 32- or 64-bit reference |
The previous user capability reservation mask before execution of thisservice call. The prev_mask argument is the 32- or64-bit address of a quadword into which the service writes a quadwordbit mask specifying the previously reserved user capabilities takenfrom the global cell SCH$GQ_RESERVED_USER_CAPS.flags
| OpenVMS usage: | mask_quadword | | type: | quadword (unsigned) | | access: | read only | | mechanism: | by 32- or 64-bit reference |
Options selected for the user capability reservation. Theflags argument is a quadword bit vector wherein a bitcorresponds to an option.Each option (bit) has a symbolic name, which the $CAPDEF macro defines.The flags argument is constructed by performing alogical OR operation using the symbolic names of each desired option. At this time, all bits are reserved to HP and must be 0.
DescriptionThe Reserve a User Capability service provides a way for discreteprocesses to communicate and synchronize their use of a user capabilityin the system. This service uses the global cellSCH$GQ_RESERVED_USER_CAPS to indicate that a particular user capabilityhas been reserved. $GET_USER_CAPABILITY can also return the currentreservation state of all user capabilities in the system.Reservation of a user capability can be made for an explicit number orfor the next available number. The selected user capability is returnedto the caller through a numeric value in select_num orby a quadword bit mask in select_mask. This service does not directly enforce unique use of the individualuser capabilities; it simply provides a common informational andcontrol resource for processes using the other capability schedulingservices. Code threads that do not use this service to verify whether auser capability is available are still at risk if differing usagesconflict. Required Privileges
The caller must have both ALTPRI and WORLD privileges to call$GET_USER_CAPABILITY to reserve a user capability. No privileges arerequired if $GET_USER_CAPABILITY is called only to retrieve the currentuser capability reservation mask. Required Quota
None Related Services
$FREE_USER_CAPABILITY, $CPU_CAPABILITIES, $PROCESS_CAPABILITIES
Condition Values Returned | SS$_NORMAL | The service completed successfully. | | SS$_ACCVIO | The service cannot access the locations specified by one or more arguments. | | SS$_INSFARG | Fewer than the required number of arguments were specified, or no operation was specified. | | SS$_NOPRIV | Insufficient privilege for the attempted operation. | | SS$_NOSUCH_OBJECT | No more user capabilities are available. | | SS$_OBJECT_EXISTS | A specifically requested user capability has already been reserved. | | SS$_TOO_MANY_ARGS | Too many arguments were presented to the system service. |
$GOTO_UNWIND (Alpha Only)On Alpha systems, unwinds the call stack.
FormatSYS$GOTO_UNWIND target_invo ,target_pc ,[new_r0] ,[new_r1]
C Prototypeint sys$goto_unwind (void *target_invo, void *(*(target_pc)), unsigned__int64 *new_r0, unsigned __int64 *new_r1);
Argumentstarget_invo
| OpenVMS usage: | invo_handle | | type: | longword (unsigned) | | access: | read only | | mechanism: | by reference |
The address of a location that contains a handle for the targetinvocation.If you do not specify the target_invo argument, or ifthe handle value is 0, an exit unwind is initiated. target_pc
| OpenVMS usage: | address | | type: | longword (unsigned) | | access: | read only | | mechanism: | by reference |
The address of a location that contains the address at which executionshould continue in the target invocation.If the target_pc argument is omitted or the value is0, a system-defined target PC is assumed and execution resumes at thelocation specified at the return address for the call frame of thetarget procedure invocation. new_r0
| OpenVMS usage: | quadword_unsigned | | type: | quadword (unsigned) | | access: | read only | | mechanism: | by reference |
The address of a location that contains the value to place in the savedR0 location of the mechanism argument vector. The contents of thislocation are then loaded into the processor R0 register at the timethat execution continues in the target invocation.If the new_r0 argument is omitted, the contents of theprocessor R0 register at the time of the call to $GOTO_UNWIND are used. new_r1
| OpenVMS usage: | quadword_unsigned | | type: | quadword (unsigned) | | access: | read only | | mechanism: | by reference |
Address of a location that contains the value to place in the saved R1location of the mechanism argument vector. The contents of the locationare then loaded into the processor R1 register at the time thatexecution continues in the target invocation.If the new_r1 argument is omitted, the contents of theprocessor R1 register at the time of the call to $GOTO_UNWIND are used.
DescriptionThe Unwind Call Stack service provides the function for a procedure tounwind the call stack.Required Access or Privileges
None Required Quota
None Related Services
$UNWIND
Condition Values Returned | SS$_NORMAL | The service completed successfully. | | SS$_ACCVIO | The specified target_invo, target_pc, new_r0, or new_r1 argument is not accessible. |
$GOTO_UNWIND_64 (Alpha and I64 only)On Alpha and I64 systems, unwinds the call stack.
FormatSYS$GOTO_UNWIND target_invo, target_pc, [NewRetVal], [NewRetVal2]
C Prototypeint sys$goto_unwind_64 (void *target_invo_64, void *(*(target_pc_64)),unsigned_int64 *new_retval, unsigned_int64 *newretval2);
Argumentstarget_invo
| OpenVMS usage: | invo_handle | | type: | quadword (unsigned) | | access: | read only | | mechanism: | by reference |
The address of a location that contains a handle for the targetinvocation.If you do not specify the target_invo argument, or ifthe handle value is 0, the effect of the call is undefined. target_pc
| OpenVMS usage: | address | | type: | quadword (unsigned) | | access: | read only | | mechanism: | by reference |
The address of a location that contains the address at which executionshould continue in the target invocation.If the target_pc argument is omitted or the value is0, execution resumes at the location specified at the return addressfor the call frame of the target procedure invocation. If the target_invo argument is omitted or the value is0, the target_pc argument is ignored. In this case, asystem-defined target PC is assumed. NewRetVal
| OpenVMS usage: | quadword_unsigned | | type: | quadword (unsigned) | | access: | read only | | mechanism: | by reference |
The address of a location that contains the value to place in the savedRetVal location of the mechanism argument vector. The contents of thislocation are then loaded into RetVal at the time that executioncontinues in the target invocation.If the NewRetVal argument is omitted, the contents ofRetVal at the time of the call to $GOTO_UNWIND_64 are used. This argument is called New_R0 in SYS$GOTO_UNWIND forcompatibility with Alpha. NewRet2
| OpenVMS usage: | quadword_unsigned | | type: | quadword (unsigned) | | access: | read only | | mechanism: | by reference |
The address of a location that contains the value to place in the savedRetVal2 location of the mechanism argument vector. The contents of thelocation are then loaded into RetVal2 at the time that executioncontinues in the target invocation.If the NewRet2 argument is omitted, the contents ofRetVal2 at the time of the call to $GOTO_UNWIND_64 are used. This argument is called New_R1 in SYS$GOTO_UNWIND forcompatibility with Alpha.
DescriptionThe Unwind Call Stack service provides the function for a procedure tounwind the call stack.Required Access or Privileges
None Required Quota
None Related Services
$UNWIND
Condition Values Returned | SS$_ACCVIO | An invalid address was given. |
$GRANTIDAdds the specified identifier record to the rights list of the processor the system.
FormatSYS$GRANTID [pidadr] ,[prcnam] ,[id] ,[name] ,[prvatr]
C Prototypeint sys$grantid (unsigned int *pidadr, void *prcnam, struct _generic_64*id, void *name, unsigned int *prvatr, unsigned int segment);
Argumentspidadr
| OpenVMS usage: | process_id | | type: | longword (unsigned) | | access: | modify | | mechanism: | by reference |
Process identification (PID) number of the process affected when$GRANTID completes execution. The pidadr argument isthe address of a longword containing the PID of the process to beaffected. You use --1 to indicate the system rights list. Whenpidadr is passed, it is also returned; therefore, youmust pass it as a variable rather than a constant. If you specifyneither pidadr nor prcnam, your ownprocess is used.prcnam
| OpenVMS usage: | process_name | | type: | character-coded text string | | access: | read only | | mechanism: | by descriptor--fixed-length string descriptor |
Process name on which $GRANTID operates. The prcnamargument is the address of a character string descriptor containing theprocess name. The maximum length of the name is 15 characters. Becausethe UIC group number is interpreted as part of the process name, youmust use pidadr to specify the rights list of aprocess in a different group. If you specify neitherpidadr nor prcnam, your own processis used.id
| OpenVMS usage: | rights_holder | | type: | quadword (unsigned) | | access: | modify | | mechanism: | by reference |
Identifier and attributes to be granted when $GRANTID completesexecution. The id argument is the address of aquadword containing the binary identifier code to be granted in thefirst longword and the attributes in the second longword.Use the id argument to modify the attributes of theidentifier. Symbol values are offsets to the bits within the longword. You can alsoobtain the values as masks with the appropriate bit set using theprefix KGB$M rather than KGB$V. The following symbols for each bitposition are defined in the macro library ($KGBDEF): | Bit Position | Meaning When Set | | KGB$V_DYNAMIC | Allows holders of the identifier to remove it from or add it to the process rights database using the DCL command SET RIGHTS_LIST. | | KGB$V_NOACCESS | Makes any access rights of the identifier null and void. This attribute is intended as a modifier for a resource identifier or the Subsystem attribute. | | KGB$V_RESOURCE | Allows holders of an identifier to charge disk space to the identifier. It is used only for file objects. | | KGB$V_SUBSYSTEM | Allows holders of the identifier to create and maintain protected subsystems by assigning the Subsystem ACE to the application images in the subsystem. | You must specify either id or name.Because the id argument is returned as well as passedif you specify name, you must pass it as a variablerather than a constant in this case. name
| OpenVMS usage: | char_string | | type: | character-coded text string | | access: | read only | | mechanism: | by descriptor--fixed-length string descriptor |
Name of the identifier granted when $GRANTID completes execution. Thename argument is the address of a descriptor pointingto the name of the identifier. The identifier is granted as it iscreated. You must specify either id orname.prvatr
| OpenVMS usage: | mask_longword | | type: | longword (unsigned) | | access: | write only | | mechanism: | by reference |
Previous attributes of the identifier. The prvatrargument is the address of a longword used to store the attributes ofthe identifier if it was previously present in the rights list. If youadded rather than modified the identifier, prvatr isignored.
DescriptionThe Grant Identifier to Process service adds the specified identifierto the rights list of the process or the system. If the identifier isalready in the rights list, its attributes are modified to thosespecified. This service is meant to be used by a privileged subsystemto alter the access rights profile of a user, based on installationpolicy. It is not meant to be used by the general system user.The result of passing the pidadr or theprcnam argument, or both, to SYS$GRANTID is summarizedin the following table: | prcnam | pidadr | Result | | Omitted | Omitted | Current process ID is used; process ID is not returned. | | Omitted | 0 | Current process ID is used; process ID is returned. | | Omitted | Specified | Specified process ID is used. | | Specified | Omitted | Specified process name is used; process ID is not returned. | | Specified | 0 | Specified process name is used; process ID is returned. | | Specified | Specified | Specified process ID is used and process name is ignored. | The result of passing the name or theid argument, or both, to SYS$GRANTID is summarized inthe following table: | name | id | Result | | Omitted | Omitted | Illegal. The INSFARG condition value is returned. | | Omitted | Specified | Specified identifier value is used. | | Specified | Omitted | Specified identifier name is used; identifier value is not returned. | | Specified | 0 | Specified identifier name is used; identifier value is returned. | | Specified | Specified | Specified identifier value is used and identifier name is ignored. | Note that a value of 0 in either of the preceding tables indicates thatthe contents of the address specified by the argument is the value 0.The word omitted indicates that the argument was not supplied. Required Access or Privileges
You need CMKRNL privilege to invoke this service. In addition, you needGROUP privilege to modify the rights list of a process in the samegroup as the calling process (unless the process has the same UIC asthe calling process). You need WORLD privilege to modify the rightslist of a process outside the caller's group. You need SYSNAM privilegeto modify the system rights list. Required Quota
None Related Services
$ADD_HOLDER, $ADD_IDENT, $ASCTOID, $CHECK_ACCESS, $CHKPRO, $CREATE_RDB,$ERAPAT, $FIND_HELD, $FIND_HOLDER, $FINISH_RDB, $FORMAT_ACL,$FORMAT_AUDIT, $GET_SECURITY, $HASH_PASSWORD, $IDTOASC, $MOD_HOLDER,$MOD_IDENT, $MTACCESS, $PARSE_ACL, $REM_HOLDER, $REM_IDENT, $REVOKID,$SET_SECURITY
Condition Values Returned | SS$_WASCLR | The service completed successfully; the rights list did not contain the specified identifier. | | SS$_WASSET | The service completed successfully; the rights list already held the specified identifier. | | SS$_ACCVIO | The pidadr argument cannot be read or written; prcnam cannot be read; id cannot be read or written; the name cannot be read; or prvatr cannot be written. | | SS$_INSFARG | You did not specify either the id or the name argument. | | SS$_INSFMEM | The process dynamic memory is insufficient for opening the rights database. | | SS$_IVIDENT | The specified identifier name is invalid; the identifier name is longer than 31 characters, contains an illegal character, or does not contain at least one nonnumeric character. | | SS$_IVLOGNAM | You specified an invalid process name. | | SS$_NONEXPR | You specified a nonexistent process. | | SS$_NOPRIV | The caller does not have CMKRNL privilege or is not running in executive or kernel mode, or the caller lacks GROUP, WORLD, or SYSNAM privilege as required. | | SS$_NOSUCHID | The specified identifier name does not exist in the rights database. Note that the binary identifier, if given, is not validated against the rights database. | | SS$_NOSYSNAM | The operation requires SYSNAM privilege. | | SS$_RIGHTSFULL | The rights list of the process or system is full. | | RMS$_PRV | The user does not have read access to the rights database. |
Because the rights database is an indexed file accessed with OpenVMSRMS, this service can also return RMS status codes associated withoperations on indexed files. For descriptions of these status codes,refer to the OpenVMS Record Management Services Reference Manual.
$HASH_PASSWORDApplies the hash algorithm you select to an ASCII password string andreturns a quadword hash value that represents the encrypted password.
FormatSYS$HASH_PASSWORD pwd ,alg ,[salt] ,usrnam ,hash
C Prototypeint sys$hash_password (void *pwd, unsigned char alg, unsigned short intsalt, void *usrnam, struct _generic_64 *hash);
Argumentspwd
| OpenVMS usage: | char_string | | type: | character-coded text string | | access: | read only | | mechanism: | by descriptor--fixed-length string descriptor |
ASCII password string to be encrypted. The pwdargument is the address of a character string descriptor pointing tothe ASCII password. The password string can contain between 1 and 32characters and use the uppercase characters A through Z, the numbers 0through 9, the dollar sign ($), and the underscore (_).The caller must validate the password string before calling$HASH_PASSWORD to ensure that only permitted characters are included. alg
| OpenVMS usage: | byte_unsigned | | type: | byte (unsigned) | | access: | read only | | mechanism: | by value |
Algorithm used to hash the ASCII password string. Thealg argument is an unsigned byte specifying the hashalgorithm.The operating system recognizes the following algorithms: | Symbolic Name | Description | | UAI$K_AD_II | Uses a CRC algorithm and returns a longword hash value. This algorithm was used in releases prior to VAX VMS Version 2.0. | | UAI$C_PURDY | Uses a Purdy algorithm over salted input. It expects a blank-padded user name and returns a quadword hash value. This algorithm was used during VAX VMS Version 2.0 field test. | | UAI$C_PURDY_V | Uses the Purdy algorithm over salted input. It expects a variable-length user name and returns a quadword hash value. This algorithm was used in releases prior to VMS Version 5.4. | | UAI$K_PURDY_S | Uses the Purdy algorithm over salted input. It expects a variable-length user name and returns a quadword hash value. This algorithm is used to hash all new passwords in VMS Version 5.4 and later. | | UAI$C_PREFERED_ALGORITHM 1 | Represents the latest encryption algorithm that the operating system uses to encrypt new passwords. Currently, it equates to UAI$C_PURDY_S. HP recommends that you use this symbol in source modules because it always equates with the most recent algorithm. |
1 The value of this symbol might be changed in futurereleases if an additional algorithm is introduced.
Values ranging from 128 to 255 are reserved for customer use; theconstant UAI$K_CUST_ALGORITHM defines the start of this range. You can use the UAI$_ENCRYPT and UAI$_ENCRYPT2 item codes with the$GETUAI system service to retrieve the primary and secondary passwordhash algorithms for a user. salt
| OpenVMS usage: | word_unsigned | | type: | word (unsigned) | | access: | read only | | mechanism: | by value |
Value used to increase the effectiveness of the hash. Thesalt argument is an unsigned word containing 16 bitsof data that is used by the hash algorithms when encrypting a passwordfor the associated user name. The $GETUAI item code UAI$_SALT is usedto retrieve the SALT value for a given user. If you do not specify aSALT value, $HASH_PASSWORD uses the value of 0.usrnam
| OpenVMS usage: | char_string | | type: | character-coded text string | | access: | read only | | mechanism: | by descriptor--fixed-length string descriptor |
Name of the user associated with the password. Theusrnam argument is the address of a descriptorpointing to a character text string containing the user name. Thecurrent password encryption algorithm (UAI$C_PURDY_S) folds the username into the ASCII password string to ensure that different users withthe same password produce different hash values. This argument must besupplied for all calls to $HASH_PASSWORD but is ignored when using theCRC algorithm (UAI$C_AD_II).hash
| OpenVMS usage: | quadword_unsigned | | type: | quadword (unsigned) | | access: | write only | | mechanism: | by reference |
Output hash value representing the encrypted password. Thehash argument is the address of an unsigned quadwordto which $HASH_PASSWORD writes the output of the hash. If you use theUAI$C_AD_II algorithm, the second longword of the hash is always set to0.
DescriptionThe Hash Password service applies the hash algorithm you select to anASCII password string and returns a quadword hash value that representsthe encrypted password.Other OpenVMS password services allow spaces, tabs, and other blankcharacters from the user, but they remove those spaces before passingthe string to $HASH_PASSWORD. Before calling $HASH_PASSWORD, all whitespace must be removed from the password string to ensure propercomparison with passwords created by other services. Required Access or Privileges
None Required Quota
None Related Services
$GETUAI, $SETUAI. Use $GETUAI to get the values for the salt andalg arguments. Use $SETUAI to store the resulting hashusing the item codes UAI$_PWD and UAI$_PWD2. For more information, see the appendix on implementing site-specificsecurity policies in the OpenVMS Programming Concepts Manual.
Condition Values Returned | SS$_NORMAL | The service completed successfully. | | SS$_ACCVIO | The input or output buffer descriptors cannot be read or written to by the caller. | | SS$_BADPARAM | The specified hash algorithm is unknown or invalid. |
$HIBERAllows a process to make itself inactive but to remain known to thesystem so that it can be interrupted; for example, to receive ASTs.
FormatSYS$HIBER
C Prototypeint sys$hiber (void);
ArgumentsNone.
DescriptionThe Hibernate service allows a process to make itself inactive but toremain known to the system so that it can be interrupted; for example,to receive ASTs. A hibernate request is a wait-for-wake-event request.When you call the Wake Process from Hibernation ($WAKE) service or whenthe time specified with the Schedule Wakeup ($SCHDWK) service occurs,the process continues execution at the instruction following theHibernate call.In VAX MACRO, you can call the Hibernate service only by using the$name_S macro. A hibernating process can be swapped out of the balance set if it isnot locked into the balance set. An AST can interrupt the wait state caused by $HIBER if the access modeat which the AST is to execute is equal to or more privileged than theaccess mode from which the hibernate request was issued and the processis enabled for ASTs at that access mode. When the AST service routine completes execution, the system reexecutesthe $HIBER service on behalf of the process. If a wakeup request hasbeen issued for the process during the execution of the AST serviceroutine (either by itself or another process), the process resumesexecution. If a wakeup request has not been issued, it continues tohibernate. If one or more wakeup requests are issued for the process while it isnot hibernating, the next hibernate call returns immediately; that is,the process does not hibernate. No count of outstanding wakeup requestsis maintained. Although this service has no arguments, a Fortran function referencemust use parentheses to indicate a null argument list, as in thefollowing example: Required Access or Privileges
None Required Quota
None Related Services
$CANEXH, $CREPRC, $DCLEXH, $DELPRC, $EXIT, $FORCEX, $GETJPI, $GETJPIW,$PROCESS_SCAN, $RESUME, $SETPRI, $SETPRN, $SETPRV, $SETRWM, $SUSPND,$WAKE
Condition Values Returned | SS$_NORMAL | The service completed successfully. |
$ICC_ACCEPTResponds to an incoming connection request. This call is used tocomplete an ICC connection from the server side.On Alpha systems, this service accepts 64-bit addresses.
FormatSYS$ICC_ACCEPT conn_handle ,[accept_buf] ,[accept_len] ,[user_context],[flags]
C Prototypeint sys$icc_accept (unsigned int conn_handle, char * accept_buf,unsigned int accept_len, unsigned int user_context, unsigned int flags);
Argumentsconn_handle
| OpenVMS usage: | connection_id | | type: | longword (unsigned) | | access: | read only | | mechanism: | by value |
The handle of the requested connection.accept_buf
| OpenVMS usage: | byte_stream | | type: | character-coded text string | | access: | read only | | mechanism: | by 32-bit or 64-bit reference (Alpha) | | mechanism: | by 32-bit reference (VAX) |
A buffer of up to 1000 bytes of accept data that is sent to the sourceof the connection at the completion of the connection process.accept_len
| OpenVMS usage: | buffer_length | | type: | longword (unsigned) | | access: | read only | | mechanism: | by value |
The actual number of bytes in accept_buf to be sent.user_context
| OpenVMS usage: | user_arg | | type: | longword (unsigned) (VAX), quadword (Alpha) | | access: | read only | | mechanism: | by value |
A user-specified value that is subsequently returned on any disconnector data events on this connection.flags
| OpenVMS usage: | mask_longword | | type: | longword (unsigned) | | access: | read only | | mechanism: | by value |
ICC$M_SYNCH_MODE can be specified to indicate that the datatransmission and reception routines $ICC_TRANSMIT, $ICC_RECEIVE, and$ICC_REPLY are allowed to return the status SS$_SYNCH in the case ofsynchronous completion, and that the AST will not be called.
DescriptionThis service is used by a server to respond to an incoming connectionrequest. The $ICC_ACCEPT service may only be called after receiving aconnection request AST.At the completion of the service, the connection is open and data canbe exchanged. Once opened, there is no logical distinction between aconnection opened by a client with the Connect service or a server withthe Accept service. A server can reject a Connection request by calling the $ICC_REJECTservice. Required Access or Privileges
None. Required Quota
$ICC_ACCEPT changes the process BYTLM quota for the length of theaccept_buf parameter, as well as a fixed value foreach potential Receive buffer on the connection. The number ofpotential Receive buffers is specified by the MAXFLOWBUFCNT parameterin the $ICC_OPEN_ASSOC service. Related Services
$ICC_CLOSE_ASSOC, $ICC_CONNECT, $ICC_CONNECTW, $ICC_DISCONNECT,$ICC_DISCONNECTW, $ICC_OPEN_ASSOC, $ICC_RECEIVE, $ICC_RECEIVEW,$ICC_REJECT, $ICC_REPLY, $ICC_REPLYW, $ICC_TRANSCEIVE,$ICC_TRANSCEIVEW, $ICC_TRANSMIT, $ICC_TRANSMITW
Condition Values Returned | SS$_NORMAL | Normal completion. | | SS$_ACCVIO | Access violation on parameter. | | SS$_BADPARAM | Bad parameter value specified. | | SS$_CLEARED | Remote association closed the link before it was accepted. | | SS$_EXQUOTA | Exceeded BYTCNT/BYTLM. | | SS$_INSFARG | Too few arguments supplied. | | SS$_INSFMEM | Not enough system resources or process virtual memory available. | | SS$_IVMODE | Attempted to accept a connection from a more privileged access mode than the requested association. | | SS$_IVCHAN | Connection not found or Invalid connection handle. | | SS$_LINKDISCON | The connection is valid, but the physical link has started to disconnect. | | SS$_TOO_MANY_ARGS | Too many arguments specified. | | SS$_WRONGSTATE | Connection is in the wrong state for the request. |
$ICC_CLOSE_ASSOCCloses the application's association with ICC.
FormatSYS$ICC_CLOSE_ASSOC assoc_handle
C Prototypeint sys$icc_close_assoc (unsigned int assoc_handle);
Argumentsassoc_handle
| OpenVMS usage: | association_id | | type: | longword (unsigned) | | access: | read only | | mechanism: | by value |
The handle of the association to be closed.
DescriptionThis service closes the application's association with ICC. If multipleassociations are open, only the specified association is closed. Whenan association is closed, any active connections on that associationare disconnected. If not explicitly closed by the application,associations opened in user mode will be closed at image exit;associations opened in inner modes will be closed at processtermination.All operations on an association must occur in the access mode at whichthe association was opened. When an association is closed, the entry (if any) in the simpleclusterwide association registry is removed. Required Access or Privileges
None. Required Quota
None. Related Services
$ICC_ACCEPT, $ICC_CONNECT, $ICC_CONNECTW, $ICC_DISCONNECT,$ICC_DISCONNECTW, $ICC_OPEN_ASSOC, $ICC_RECEIVE, $ICC_RECEIVEW,$ICC_REJECT, $ICC_REPLY, $ICC_REPLYW, $ICC_TRANSCEIVE,$ICC_TRANSCEIVEW, $ICC_TRANSMIT, $ICC_TRANSMITW
Condition Values Returned | SS$_NORMAL | Normal completion. | | SS$_INSFARG | The assoc_handle was not supplied. | | SS$_IVCHAN | Invalid association handle. | | SS$_IVMODE | Attempted to close an association from a more privileged access mode than the requested association. | | SS$_TOO_MANY_ARGS | Too many arguments specified. |
$ICC_CONNECTEstablishes a connection to a remote application over an openassociation.On Alpha systems, this service accepts 64-bit addresses.
FormatSYS$ICC_CONNECT ios_icc ,[astadr] ,[astprm] ,assoc_handle ,conn_handle,remote_assoc ,[remote_node] ,[user_context] ,[conn_buf],[conn_buf_len] ,[return_buf] ,[return_buf_len] ,[retlen_addr] ,[flags]
C Prototypeint sys$icc_connect (struct _ios_icc *ios_icc, void(*astadr)(__unknown_params), __int64 astprm, unsigned int assoc_handle,unsigned int *conn_handle, void *remote_assoc, void *remote_node,unsigned int user_context, char *conn_buf, unsigned int conn_buf_len,char *return_buf, unsigned int return_buf_len, unsigned int*retlen_addr, unsigned int flags);
Argumentsios_icc
| OpenVMS usage: | io_status_block | | type: | quadword (unsigned) | | access: | write only | | mechanism: | by 32-bit or 64-bit reference (Alpha) | | mechanism: | by 32-bit reference (VAX) |
I/O status block:
 Completion status values: SS$_NORMAL, SS$_BUFFEROVF, SS$_EXQUOTA, SS$_INSFMEM, SS$_IVBUFLEN,SS$_LINKABORT, SS$_LINKDISCON, SS$_NOLOGNAM, SS$_NOSUCHOBJ,SS$_NOSUCHNODE, SS$_PATHLOST, SS$_REJECT, SS$_SSFAIL, SS$_UNREACHABLE,SS$_WRONGSTATE The second longword is undefined unless the completion code isSS$_REJECT. In this case, the application-defined rejection reason codeis supplied by the server when $ICC_REJECT is called. astadr
| OpenVMS usage: | ast_procedure | | type: | procedure_entry_mask | | access: | call without stack unwinding | | mechanism: | by 32-bit or 64-bit linkage reference (Alpha) | | mechanism: | by 32-bit reference (VAX) |
The AST routine to be executed when the operation completes.astprm
| OpenVMS usage: | user_arg | | type: | quadword (unsigned) (Alpha), longword (unsigned) (VAX) | | access: | read only | | mechanism: | by 64-bit value (Alpha) | | mechanism: | by 32-bit value (VAX) |
The parameter to be passed to the AST routine.assoc_handle
| OpenVMS usage: | association_id | | type: | longword (unsigned) | | access: | read only | | mechanism: | by value |
The handle of the association on which the connection is to be opened.The constant ICC$C_DFLT_ASSOC_HANDLE, if used, indicates that thedefault association is to be used (and opened if necessary).conn_handle
| OpenVMS usage: | longword_unsigned | | type: | longword (unsigned) | | access: | write only | | mechanism: | by 32-bit or 64-bit reference (Alpha) | | mechanism: | by 32-bit reference (VAX) |
The 32-bit or 64-bit address (on Alpha systems) or the 32-bit address(on VAX systems) of a longword into which $ICC_CONNECT writes theconnection handle of the created connection on a successful call.remote_assoc
| OpenVMS usage: | char_string | | type: | character-coded text string | | access: | read only | | mechanism: | by 32-bit or 64-bit descriptor (Alpha) | | mechanism: | by 32-bit descriptor (VAX) |
An ASCII character string (31 characters maximum) specifying the nameof the target application to connect to. Association names are casesensitive.remote_node
| OpenVMS usage: | char_string | | type: | character-coded text string | | access: | read only | | mechanism: | by 32-bit or 64-bit descriptor (Alpha) | | mechanism: | by 32-bit descriptor (VAX) |
The name of the node where the target association resides. A null orblank string can be used to indicate the local node. If omitted (bypassing zero by value), the simple clusterwide association registry isto be used. Each node name is a one-to-six character SCS node name. Acomma-delimited list of nodes may be specified, indicating that one isto be chosen at random.user_context
| OpenVMS usage: | user_arg | | type: | longword (unsigned) (VAX), quadword (Alpha) | | access: | read only | | mechanism: | by value |
A user-specified value to be subsequently returned on any disconnect ordata events on this connection.conn_buf
| OpenVMS usage: | byte_stream | | type: | character-coded text string | | access: | read only | | mechanism: | by 32-bit or 64-bit reference (Alpha) | | mechanism: | by 32-bit reference (VAX) |
A buffer of up to 1000 bytes of connection data to be sent to thetarget of the connection during the connection process.conn_buf_len
| OpenVMS usage: | buffer_length | | type: | longword (unsigned) | | access: | read only | | mechanism: | by value |
The number of bytes in conn_buf to be sent.return_buf
| OpenVMS usage: | byte_stream | | type: | character-coded text string | | access: | read only | | mechanism: | by 32-bit or 64-bit reference (Alpha) | | mechanism: | by 32-bit reference (VAX) |
A buffer of up to 1000 bytes in length to receive any incomingconnection accept or reject data returned.return_buf_len
| OpenVMS usage: | buffer_length | | type: | longword (unsigned) | | access: | read only | | mechanism: | by value |
The length of the supplied return_buf.retlen_addr
| OpenVMS usage: | longword_unsigned | | type: | longword (unsigned) | | access: | write only | | mechanism: | by 32-bit or 64-bit reference (Alpha) | | mechanism: | by 32-bit reference (VAX) |
The 32-bit or 64-bit address (on Alpha systems) or the 32-bit address(on VAX systems) of a longword into which $ICC_CONNECT writes theactual length (in bytes) of any user accept or reject data returned inthe buffer return_buf.flags
| OpenVMS usage: | mask_longword | | type: | longword (unsigned) | | access: | read only | | mechanism: | by value |
ICC$M_SYNCH_MODE can be specified to indicate that the datatransmission and reception routines $ICC_TRANSMIT, $ICC_RECEIVE, and$ICC_REPLY are allowed to return the status SS$_SYNCH in the case ofsynchronous completion, indicating that the AST will not be called.
DescriptionThis service establishes a connection to a remote application over anopen association. Connections must be opened in the same mode as theirassociation. If the user provides the default association constantICC$C_DFLT_ASSOC_HANDLE as its association handle, the defaultassociation will be used; it will be opened if it is not already open.Multiple connections are possible over a single association. Whencompletion is signaled by the AST routine, the application must checkthe completion status field of the IOS_ICC to determine if the serverhas accepted or rejected the connection request. The number ofconnections is subject to process BYTLM quota.At image exit, as a result of closing any open user mode associations,all user mode connections are disconnected. Inner mode connections arethe responsibility of the inner mode code, but are disconnected atprocess termination when inner mode associations are closed.Connections are only visible to the mode in which they were opened. A client opens connections with the $ICC_CONNECT service; a serveropens connections with the $ICC_ACCEPT service. Required Access or Privileges
SYSNAM, or access via ICC Security Object. Refer to the HP OpenVMS System Manager's Manualfor more information. Required Quota
$ICC_CONNECT changes the process BYTLM quota for the length of theconn_buf parameter, as well as a fixed value for eachpotential Receive buffer on the connection. The number of potentialReceive buffers is specified by the MAXFLOWBUFCNT parameter in the$ICC_OPEN_ASSOC service. If $ICC_OPEN_ASSOC is not called before $ICC_CONNECT, the default valueof MAXFLOWBUFCNT is used (currently 5). Related Services
$ICC_ACCEPT, $ICC_CLOSE_ASSOC, $ICC_CONNECTW, $ICC_DISCONNECT,$ICC_DISCONNECTW, $ICC_OPEN_ASSOC, $ICC_RECEIVE, $ICC_RECEIVEW,$ICC_REJECT, $ICC_REPLY, $ICC_REPLYW, $ICC_TRANSCEIVE,$ICC_TRANSCEIVEW, $ICC_TRANSMIT, $ICC_TRANSMITW
Condition Values Returned | SS$_NORMAL | Normal completion. | | SS$_ACCVIO | Access violation on parameter. | | SS$_BADPARAM | Bad parameter value specified. | | SS$_BUFFEROVF | Overflow on inbound accept or reject data. | | SS$_EXQUOTA | Not enough AST quota (asynchronous request) or insufficient BYTLM/BYTCNT. | | SS$_INSFARG | Too few arguments were supplied, or required arguments not supplied. | | SS$_INSFMEM | Not enough system resources or process virtual memory available. | | SS$_INSFP1POOL | Not enough process P1 space available. | | SS$_IVBUFLEN | The length of the context data or the accept or reject data buffer is more than 1000 bytes. | | SS$_IVCHAN | Invalid association handle. | | SS$_IVMODE | Attempted to open a connection from a more privileged access mode than the requested association. | | SS$_LINKABORT | The communications link to the target node was lost. | | SS$_LINKDISCON | The communications link to the target node was lost. | | SS$_NOLINKS | Too many connections open. | | SS$_NOLOGNAM | The underlying layers failed to start properly during system initialization. | | SS$_NOPRIV | No privilege to connect to the specified association. Connection access is granted either through an ICC security object or through the SYSNAM privilege. If no security object exists and the caller lacks the SYSNAM privilege, SS$_NOPRIV is returned rather than SS$_NOSUCHOBJ. | | SS$_NOSUCHOBJ | The remote association name and/or node was not found. | | SS$_NOSUCHNODE | The target node is not known. | | SS$_PATHLOST | The communications link to the target node was lost. | | SS$_REMRSRC | Insufficient resources at remote node. | | SS$_REJECT | The remote association or node rejected the connection request. | | SS$_TOO_MANY_ARGS | Too many arguments specified. | | SS$_UNREACHABLE | Target node currently unreachable. | | SS$_WRONGSTATE | Connection is in the wrong state for the request. |
$ICC_CONNECTWEstablishes a link between two ICC associations.The $ICC_CONNECTW service completes synchronously; that is, it returnsto the caller after the server has either accepted or rejected theconnection request. For asynchronous completion, use the $ICC_CONNECT service; $ICC_CONNECTreturns to the caller as soon as the connection request has been sentto the server, without waiting for a response from the server. On Alpha, this service accepts 64-bit addresses.
FormatSYS$ICC_CONNECTW ios_icc, [astadr], [astprm], assoc_handle,conn_handle, remote_assoc, [remote_node], [user_context], [conn_buf],[conn_buf_len], [return_buf], [return_buf_len], [retlen_addr], [flags]
C Prototypeint sys$icc_connectw (struct _ios_icc *ios_icc, void(*astadr)(__unknown_params), __int64 astprm, unsigned int assoc_handle,unsigned int *conn_handle, void *remote_assoc, void *remote_node,unsigned int user_context, char *conn_buf, unsigned int conn_buf_len,char *return_buf, unsigned int return_buf_len, unsigned int*retlen_addr, unsigned int flags);
$ICC_DISCONNECTTerminates the specified connection.On Alpha systems, this service accepts 64-bit addresses.
FormatSYS$ICC_DISCONNECT conn_handle ,iosb ,[astadr] ,[astprm] ,[disc_buf],[disc_buf_len]
C Prototypeint sys$icc_disconnect (unsigned int conn_handle, struct _iosb, *iosb,void (*astadr)(__unknown_params), __int64 astprm, char * disc_buf,unsigned int disc_buf_len);
Argumentsconn_handle
| OpenVMS usage: | connection_id | | type: | longword (unsigned) | | access: | read only | | mechanism: | by value |
The ID of the connection to be disconnected.iosb
| OpenVMS usage: | io_status_block | | type: | quadword (unsigned) | | access: | write only | | mechanism: | by 32-bit or 64-bit reference (Alpha) | | mechanism: | by 32-bit reference (VAX) |
I/O status block:
 Completion status values: SS$_NORMAL, SS$_EXQUOTA, SS$_LINKDISCON, $ICC_REJECT astadr
| OpenVMS usage: | ast_procedure | | type: | procedure_entry_mask | | access: | call without stack unwinding | | mechanism: | by 32-bit or 64-bit linkage reference (Alpha) | | mechanism: | by 32-bit reference (VAX) |
The AST routine to be executed when the operation completes.astprm
| OpenVMS usage: | user_arg | | type: | quadword (unsigned) (Alpha), longword (unsigned) (VAX) | | access: | read only | | mechanism: | by 64-bit value (Alpha) | | mechanism: | by 32-bit value (VAX) |
The parameter to be passed to the AST routine.disc_buf
| OpenVMS usage: | byte_stream | | type: | character-coded text string | | access: | read only | | mechanism: | by 32-bit or 64-bit reference (Alpha) | | mechanism: | by 32-bit reference (VAX) |
A buffer of up to 1000 bytes of disconnect data to be sent to thepartner in the connection when notifying it that disconnection is beinginitiated. Delivery of this data is not guaranteed.disc_buf_len
| OpenVMS usage: | buffer_length | | type: | longword (unsigned) | | access: | read only | | mechanism: | by value |
The number of bytes in disc_buf to be sent.
DescriptionThis service must be called in the mode in which the association wasopened.This service terminates the specified connection. After this service iscalled, no further communication is possible over this connection. Alloutstanding data transmission and reception functions are terminatedwith an error before completion is signaled by calling the AST (ifsupplied). A connection may be disconnected by either party. Proper programmingprocedure for network communications strongly recommends that the partythat last received a message initiate the disconnection. If the partythat last sent a message initiates the disconnection, there is noguarantee that the message was delivered. Similarly, although this interface provides the ability to senddisconnect data, only noncritical information should be transmittedwith the disconnect data mechanism, because there is no guarantee thatthe data will have been received or acted upon by the other party tothe connection. Required Access or Privileges
None. Required Quota
BYTLM (disc_buf) Related Services
$ICC_ACCEPT, $ICC_CLOSE_ASSOC, $ICC_CONNECT, $ICC_CONNECTW,$ICC_DISCONNECTW, $ICC_OPEN_ASSOC, $ICC_RECEIVE, $ICC_RECEIVEW,$ICC_REJECT, $ICC_REPLY, $ICC_REPLYW, $ICC_TRANSCEIVE,$ICC_TRANSCEIVEW, $ICC_TRANSMIT, $ICC_TRANSMITW
Condition Values Returned | SS$_NORMAL | Normal successful completion. | | SS$_ACCVIO | Access violation on parameter. | | SS$_BADPARAM | Bad parameter value specified. | | SS$_INSFMEM | Not enough nonpaged pool. | | SS$_IVBUFLEN | The length of the disconnect data buffer is more than 1000 bytes. | | SS$_IVCHAN | Unknown connection specified or invalid connection handle. | | SS$_IVMODE | Attempted to disconnect a connection from a more privileged access mode than the requested connection. | | SS$_LINKDISCON | The remote association closed the connection before it was accepted or rejected. | | SS$_TOO_MANY_ARGS | Too many arguments specified. |
$ICC_DISCONNECTWTerminates a link between two ICC associations.The $ICC_DISCONNECTW service completes synchronously; that is, itreturns to the caller after the connection has completely finished thedisconnection request. For asynchronous completion, use the $ICC_DISCONNECT service;$ICC_DISCONNECT returns to the caller as soon as the disconnectionrequest has been sent to the transport layer, without waiting fornotification that the disconnection has completed. On Alpha, this service accepts 64-bit addresses.
FormatSYS$ICC_DISCONNECTW conn_handle ,iosb ,[astadr] ,[astprm] ,[disc_buf],[disc_buf_len]
C Prototypeint sys$icc_disconnectw (unsigned int conn_handle, struct _iosb, *iosb,void (*astadr)(__unknown_params), __int64 astprm, char * disc_buf,unsigned int disc_buf_len);
$ICC_OPEN_ASSOCDeclares an application association with ICC.On Alpha systems, this service accepts 64-bit addresses.
FormatSYS$ICC_OPEN_ASSOC assoc_handle ,[assoc_name] ,[logical_name],[logical_table] ,[conn_event_rtn] ,[disc_event_rtn] ,[recv_rtn],[maxflowbufcnt] ,[prot]
C Prototypeint sys$icc_open_assoc (unsigned int *assoc_handle, void *assoc_name,void *logical_name, void *logical_table, void(*conn_event_rtn)(__unknown_params), void(*disc_event_rtn)(__unknown_params), void(*recv_rtn)(__unknown_params), unsigned int maxflowbufcnt, unsigned intprot);
Argumentsassoc_handle
| OpenVMS usage: | association_id | | type: | longword (unsigned) | | access: | write only | | mechanism: | by 32-bit or 64-bit reference (Alpha) | | mechanism: | by 32-bit reference (VAX) |
The 32-bit or 64-bit address (on Alpha systems) or the 32-bit address(on VAX systems) of a longword into which $ICC_OPEN_ASSOC writes thehandle assigned to the opened association.assoc_name
| OpenVMS usage: | char_string | | type: | character-coded text string | | access: | read only | | mechanism: | by 32-bit or 64-bit descriptor (Alpha) | | mechanism: | by 32-bit descriptor (VAX) |
An ASCII character string of up to 31 characters in length specifyingthe name of the application opening the association. Null (0 length),and empty or blank association names are not allowed. If this argumentis omitted (that is, a zero is passed in by value), it signifies thatthe user wants to open the default association. This argument is casesensitive.logical_name
| OpenVMS usage: | logical name | | type: | character-coded text string | | access: | read only | | mechanism: | by 32-bit or 64-bit descriptor (Alpha) | | mechanism: | by 32-bit descriptor (VAX) |
A logical name in a clusterwide logical name table used to maintain thesimple association registry. The logical name represents the name ofthe service provided by the application. Logical names are casesensitive.logical_table
| OpenVMS usage: | logical name table | | type: | character-coded text string | | access: | read only | | mechanism: | by 32-bit or 64-bit descriptor (Alpha) | | mechanism: | by 32-bit descriptor (VAX) |
The table containing the logical name logical_name.Logical name tables are converted to uppercase. Unless your applicationrequires an application-specific logical name table, this argumentshould be either the default ICC Registry search list (ICC$REGISTRY),or the default registry table (ICC$REGISTRY_TABLE).conn_event_rtn
| OpenVMS usage: | user_routine | | type: | procedure_entry_mask | | access: | call without stack unwinding | | mechanism: | by 32-bit or 64-bit linkage reference (Alpha) | | mechanism: | by 32-bit reference (VAX) |
The address of the AST routine to be called for incoming connectevents. This routine will be called in the mode of the caller. (Nomechanism is provided for the routine to be called at a different mode).You must have a conn_event_rtn to operate as a server. disc_event_rtn
| OpenVMS usage: | user_routine | | type: | procedure_entry_mask | | access: | call without stack unwinding | | mechanism: | by 32-bit or 64-bit linkage reference (Alpha) | | mechanism: | by 32-bit reference (VAX) |
The address of the AST routine to be called for incoming disconnectevents. This routine will be called in the mode of the caller. (Nomechanism is provided for the routine to be called at a differentmode). The arguments, conn_event_rtn, anddisc_event_rtn, may reference the same routine.recv_rtn
| OpenVMS usage: | user_routine | | type: | procedure_entry_mask | | access: | call without stack unwinding | | mechanism: | by 32-bit or 64-bit linkage reference (Alpha) | | mechanism: | by 32-bit reference (VAX) |
The address of the AST routine to be called for incoming new dataevents.If the user provides this routine, it indicates that the user willsupply a buffer of the size required (specified in an argument to therecv_rtn at each call) each time one is requested. Ifthe user supplies this routine, receive calls should only be issuedafter receive events arrive and sufficient buffer space has beenallocated to handle the incoming data. This routine will be called in the mode of the caller. (No mechanism isprovided for the routine to be called at a different mode). maxflowbufcnt
| OpenVMS usage: | longword_unsigned | | type: | longword (unsigned) | | access: | read only | | mechanism: | by value |
The maximum number of pending inbound messages (per connection) thatICC will allow the user before initiating flow control. A message ispending if it is being held within ICC but no receive call(s) areoutstanding from the user.Default = 5 (Pass 0 to get the default) prot
| OpenVMS usage: | longword_unsigned | | type: | longword (unsigned) | | access: | read only | | mechanism: | by value |
This argument is ignored for non-server applications.The default protection scheme for this association is as follows: 0 - access for everyone (default)
1 - stops WORLD access
2 - stops both WORLD and GROUP access Advanced access control is provided by ICC Security objects. Refer tothe HP OpenVMS System Manager's Manual for information on ICC system management and security.
DescriptionThis service declares an application association with ICC. Servers mustmake this call to declare or register their name and to indicate theirreadiness to receive incoming connections. Although a client ispermitted to call this routine, it is unnecessary for simpleapplications. A client application that wishes to be notified ofdisconnection events or Receive Data events must call the$ICC_OPEN_ASSOC service.A client can open a connection without specifying an open association;this automatically creates a default association name ofICC$PID_nnnnnnnn (where nnnnnnnn is a character representation of theProcess ID). NETMBX privilege is required to open any association. The association name space is a controlled resource. Refer to theHP OpenVMS System Manager's Manual for information on managing this resource. An attempt to open an association with a name not authorized asdescribed in the HP OpenVMS System Manager's Manual will fail with the error SS$_NOPRIVreturned to the caller. In addition to making entries in the system'slocal association name space, a call to $ICC_OPEN_ASSOC may also makean entry in a simple clusterwide registry of active associations. An association may only be accessed from the mode in which it wasopened. Inner modes are prevented from using the default association. An application can open any number of associations subject to availableprocess BYTLM quota. Currently, there is a systemwide limit of 512 openassociations. There is no limit imposed clusterwide. Description of User-Supplied Routines (ASTs)
When opening an association, the user may optionally supply aconnect/disconnect AST and/or a Data Event AST. These routines will beused for all connections established over the specified association. Inaddition, for any of the asynchronous services (those provided withboth an immediate return and a "W" form), a completion AST may besupplied by the user. This section describes these ASTs. 1. Connect and Disconnect AST
The user chooses the name of this routine and supplies the procedurename as an argument to the Open Association service. Seven argumentswill be passed to the user. The first argument notifies the user whether this is an incoming newconnection or a disconnection of an existing connection. The secondidentifies the connection. The third and fourth provide access toincoming connect or disconnect data (if any) sent by the cooperatingapplication. The fifth argument provides the number of bytes availablefor any optional Accept or Reject data (in the case of a connectrequest) or the disconnect reason supplied by the cooperatingapplication (if any). For connect events, the sixth and seventh arguments are the EPID anduser name of the process requesting the connect, respectively. The user has the choice of using and declaring a common routine orseparate routines as specified when calling $OPEN_ASSOCIATION. Format
ConnDiscRtn event_type ,conn_handle ,data_len ,data_bfr ,P5 ,P6 ,P7 | C Prototype
void ConDiscRtn (unsigned int event_type, unsigned int conn_handle, unsigned int data_len, char *data_bfr, unsigned int P5, unsigned int P6, char *P7); | Arguments
event_typeType: longword (unsigned)Access: read onlyMechanism: by value | This field will contain a code describing the type of event. Thepossible event codes are defined in ICCDEF:
ICC$C_EV_CONNECT - Connection eventICC$C_EV_DISCONNECT - Disconnection event |
conn_handleType: longword (unsigned)Access: read onlyMechanism: by value | The handle of the connection associated with the event.
data_lenType: longword (unsigned)Access: read onlyMechanism: by value | The length (in bytes) of the incoming data. This value specifies thelength of the buffer data_bfr, and will be between 0and 1000, with zero indicating no data.
data_bfrType: character-coded text stringAccess: read onlyMechanism: by 32-bit or 64-bit value (Alpha) by 32-bit value (VAX) | The 32-bit address of the P1-space buffer containing the data, or zeroif no data is available. The length of this buffer is specified by theargument data_len. Upon return from the AST, the address of the data is no longer valid.An application wishing to reference the Connection or Disconnectiondata after Return must copy the data from the supplied buffer tostorage owned by the application.
P5Type: longword (unsigned)Access: read onlyMechanism: by value | The usage of this argument is dependent on the specified event typecode (event_type). For connect events (event_type=ICC$C_EV_CONNECT), thisargument contains the length (in bytes) of the buffer available for areply. For disconnect events(event_type=ICC$C_EV_DISCONNECT), this argumentcontains the user-defined disconnect reason/status from the remotepartner.
P6Type: longword (unsigned) (VAX), quadword (Alpha)Access: read onlyMechanism: by value | The usage of this argument is dependent on the specified event typecode (event_type). For connect events (event_type=ICC$C_EV_CONNECT), thisargument contains the EPID of the process requesting the connection,passed by value. For disconnect events(event_type=ICC$C_EV_DISCONNECT), this argumentcontains the user-defined user_context supplied whenthe connection was opened. For a client, theuser_context is that supplied to the $ICC_CONNECTcall. For a server, it is the value supplied to $ICC_ACCEPT.
P7Type: character-coded text stringAccess: read onlyMechanism: by reference | For connect events: Username, passed by reference (to P1 space buffer)as a 12-character, space-filled string. The application must copy this information to local storage beforeexiting from the connect routine. For disconnect events, this argument is zero (0). 2. Data Event Routine
This routine, if supplied by the user when opening the association,allows the user to be notified of any pending data events over anyconnections subsequently opened over that association. If the user has supplied this routine, the Receive service must only becalled in response to incoming data events signaled by this routine,and must be called with a buffer large enough to handle the messagesize specified. Use of this routine obligates the user to allocate buffers up to thesize requested by the cooperating application. The only recoveryprovided at this time if a sufficiently large buffer cannot beallocated is to disconnect the connection. Failure to issue a receivecall or disconnect may stall all further communication on thisconnection. Format
DataEventRtn message_size ,conn_handle ,user_context | C Prototype
void DataEventRtn (unsigned int message_size, unsigned int conn_handle, unsigned int user_context); | Arguments
message_sizeType: longword (unsigned)Access: read onlyMechanism: by value | This field will contain the number of bytes in the pending data event.
conn_handleType: longword (unsigned)Access: read onlyMechanism: by value | The handle of the connection associated with the event. This valueshould be used as the conn_handle argument to$ICC_RECEIVE.
user_contextType: longword (unsigned) (VAX), quadword (Alpha)Access: read onlyMechanism: by value | The user-defined user_context supplied when theconnection was opened. For a client, the user context is that suppliedto the $ICC_CONNECT call. For a server, it is the value supplied to$ICC_ACCEPT. 3. Completion ASTs
Completion ASTs may be supplied to the $ICC_CONNECT[W],$ICC_DISCONNECT[W], $ICC_TRANSMIT[W], $ICC_RECEIVE[W],$ICC_TRANSCEIVE[W], and $ICC_REPLY[W] services. In all cases, they arecalled at the completion of the requested operation, with the singleargument, the AST parameter supplied when the original service wascalled, passed by value. Completion ASTs are not called if the service returns an error prior toinitiating the operation. $ICC_CONNECT and $ICC_ACCEPT accept the flagICC$V_SYNCH_MODE which indicates that the routines $ICC_TRANSMIT[W],$ICC_RECEIVE[W], and $ICC_REPLY[W] are permitted to return the statusSS$_SYNCH, which will indicate that completion has already occurred andthe AST will not be called. Required Access or Privileges
Refer to the HP OpenVMS System Manager's Manual for more information. Required Quota
BYTCNT, BYTLM Related Services
$ICC_ACCEPT, $ICC_CLOSE_ASSOC, $ICC_CONNECT, $ICC_CONNECTW,$ICC_DISCONNECT, $ICC_DISCONNECTW, $ICC_RECEIVE, $ICC_RECEIVEW,$ICC_REJECT, $ICC_REPLY, $ICC_REPLYW, $ICC_TRANSCEIVE,$ICC_TRANSCEIVEW, $ICC_TRANSMIT, $ICC_TRANSMITW
Condition Values Returned | SS$_NORMAL | Normal completion. | | SS$_ACCVIO | Access violation on parameter. | | SS$_BADPARAM | Bad parameter value specified. | | SS$_DUPLNAM | Specified association name is already registered (already exists), or default association is already open. | | SS$_EXQUOTA | One or more process quotas has been exceeded (probably BYTCNT/BYTLM). | | SS$_INSFARG | Too few arguments supplied. | | SS$_INSFMEM | Not enough system resources or process virtual memory available. | | SS$_IVMODE | Attempt to open default association from other than user mode. | | SS$_NOLINKS | Too many associations open for this process. | | SS$_NONETMBX | Request requires NETMBX privilege. | | SS$_NOPRIV | No privilege for association name access or logical name table access if using the Registry. | | SS$_SSFAIL | Transport association name table is full, systemwide. | | SS$_TOO_MANY_ARGS | Too many arguments were specified.
Any failures from the system services: $ENQ, $DEQ, $CRELNM, $TRNLNM. |
$ICC_RECEIVEReceives a single message over a connection.On Alpha systems, this service accepts 64-bit addresses.
FormatSYS$ICC_RECEIVE conn_handle ,ios_icc ,[astadr] ,[astprm] ,recv_buf,recv_buf_len
C Prototypesys$icc_receive (unsigned int conn_handle, struct _ios_icc *ios_icc,void (*astadr)(__unknown_params), __int64 astprm, char *recv_buf,unsigned int recv_buf_len);
Argumentsconn_handle
| OpenVMS usage: | connection_id | | type: | longword (unsigned) | | access: | read only | | mechanism: | by value |
The handle of the fully established connection.ios_icc
| OpenVMS usage: | io_status_block | | type: | four longwords (unsigned) | | access: | write only | | mechanism: | by 32-bit or 64-bit reference (Alpha) | | mechanism: | by 32-bit reference (VAX) |
I/O status block:
 Completion codes: SS$_NORMAL, SS$_EXQUOTA, SS$_INSFMEM, SS$_LINKDISCON, SS$_BUFOVL,SS$_ACCVIO astadr
| OpenVMS usage: | ast_procedure | | type: | procedure_entry_mask | | access: | call without stack unwinding | | mechanism: | by 32-bit or 64-bit linkage reference (Alpha) | | mechanism: | by 32-bit reference (VAX) |
The AST routine to be executed when the operation completes.astprm
| OpenVMS usage: | user_arg | | type: | quadword (unsigned) (Alpha) | | access: | longword (unsigned) (VAX) | | mechanism: | read only | | mechanism: | by 64-bit value (Alpha) |
The parameter to be passed to the AST routine.recv_buf
| OpenVMS usage: | byte_stream | | type: | character-coded text string | | access: | read only | | mechanism: | by 32-bit or 64-bit reference (Alpha) | | mechanism: | by 32-bit reference (VAX) |
The 32-bit or 64-bit address (on Alpha systems) or the 32-bit address(on VAX systems) of the buffer to receive the incoming data. The lengthof this buffer is specified by the argumentrecv_buf_len.recv_buf_len
| OpenVMS usage: | buffer_length | | type: | longword (unsigned) | | access: | read only | | mechanism: | by value |
The length (in bytes) of the buffer available to hold the incomingdata. This value specifies the length of the bufferrecv_buf.IOS_ICC Arguments:
recvlen (output)
| OpenVMS usage: | longword unsigned | | type: | longword (unsigned) | | access: | write only | | mechanism: | by value |
This parameter is returned in the ios_icc.$ICC_RECEIVE writes the actual length of the incoming data messagereceived from the target application (in bytes) into offsetios_icc$l_rcv_len of the ios_icc.request_handle (output)
| OpenVMS usage: | request_id | | type: | longword (unsigned) | | access: | write only | | mechanism: | by value |
This parameter is returned in the ios_icc.$ICC_RECEIVE writes the Request/Response handle into offsetios_icc$l_req_handle of the ios_icc.The request_handle argument is nonzero if theapplication is expected to reply to this message.reply_len (output)
| OpenVMS usage: | longword_unsigned | | type: | longword (unsigned) | | access: | write only | | mechanism: | by value |
This parameter is returned in the ios_icc. The$ICC_RECEIVE service writes the maximum length (in bytes) of theexpected Reply message into offset ios_icc$l_reply_lenof the ios_icc, if request_handle isnonzero.
DescriptionThis service receives a single message over a connection. If a RequestID is returned at completion, the partner has used a Transceive systemservice and requires data to be returned with a Reply service.For efficiency reasons, the number of parameters on this routine hasbeen limited to six parameters. Three additional values are returned bythe ios_icc data structure. Required Access or Privileges
None. Required Quota
BYTLM Related Services
$ICC_ACCEPT, $ICC_CLOSE_ASSOC, $ICC_CONNECT, $ICC_CONNECTW,$ICC_DISCONNECT, $ICC_DISCONNECTW, $ICC_OPEN_ASSOC, $ICC_RECEIVEW,$ICC_REJECT, $ICC_REPLY, $ICC_REPLYW, $ICC_TRANSCEIVE,$ICC_TRANSCEIVEW, $ICC_TRANSMIT, $ICC_TRANSMITW
Condition Values Returned | SS$_NORMAL | Normal completion. | | SS$_ACCVIO | Access violation on parameter. | | SS$_EXBYTLM | Insufficient byte count quota. | | SS$_EXQUOTA | One or more process quotas has been exceeded. | | SS$_INSFARG | Too few arguments supplied. | | SS$_IVCHAN | Unknown connection specified or invalid connection handle. | | SS$_IVMODE | Attempted to use a connection from a more privileged access mode than the mode in which it was opened. | | SS$_LINKDISCON | The connection has been disconnected. | | SS$_SYNCH | If synchronous mode was requested at connection time, this return value indicates that completion has already occurred and the AST routine, if specified, will not be called. | | SS$_TOO_MANY_ARGS | Too many arguments specified. | | SS$_WRONGSTATE | Connection is in the wrong state for the request. |
$ICC_RECEIVEWThe Intra-Cluster Communications Receive and Wait service queues areceive request to the specified connection.The $ICC_RECEIVEW service completes synchronously; that is, it returnsto the caller with data. For asynchronous completion, use the $ICC_RECEIVE service; $ICC_RECEIVEreturns to the caller as soon as the receive request is queued, withoutwaiting for data on the connection. On Alpha, this service accepts 64-bit addresses.
FormatSYS$ICC_RECEIVEW conn_handle ,ios_icc ,[astadr] ,[astprm] ,recv_buf,recv_buf_len
C Prototypesys$icc_receivew (unsigned int conn_handle, struct _ios_icc *ios_icc,void (*astadr)(__unknown_params), __int64 astprm, char *recv_buf,unsigned int recv_buf_len);
$ICC_REJECTRefuses a connection request.On Alpha systems, this service accepts 64-bit addresses.
FormatSYS$ICC_REJECT conn_handle, [reject_buf], [reject_buf_len], [reason]
C Prototypeint sys$icc_reject (unsigned int conn_handle, char * reject_buf,unsigned int reject_buf_len, unsigned int reason);
Argumentsconn_handle
| OpenVMS usage: | connection_id | | type: | longword (unsigned) | | access: | read only | | mechanism: | by value |
The handle of the requested connection.reject_buf
| OpenVMS usage: | byte_stream | | type: | character-coded text string | | access: | read only | | mechanism: | by 32-bit or 64-bit reference (Alpha) | | mechanism: | by 32-bit reference (VAX) |
A buffer of up to 1000 bytes of reject data to be sent to the source ofthe connection at the completion of the rejection process.reject_buf_len
| OpenVMS usage: | buffer_length | | type: | longword (unsigned) | | access: | read only | | mechanism: | by value |
The number of bytes in reject_buf to be sent.reason
| OpenVMS usage: | cond_code | | type: | longword (unsigned) | | access: | read only | | mechanism: | by value |
User-specified reject reason code to be supplied to the remoteapplication.Default = SS$_REJECT
DescriptionThis service is used by a server to refuse an incoming connectionrequest. The $ICC_REJECT service may only be called after receiving aconnection request AST. After the completion of the service, the clientis notified that the connection was not opened.Required Access or Privileges
None. Required Quota
None. Related Services
$ICC_ACCEPT, $ICC_CLOSE_ASSOC, $ICC_CONNECT, $ICC_CONNECTW,$ICC_DISCONNECT, $ICC_DISCONNECTW, $ICC_OPEN_ASSOC, $ICC_RECEIVE,$ICC_RECEIVEW, $ICC_REPLY, $ICC_REPLYW, $ICC_TRANSCEIVE,$ICC_TRANSCEIVEW, $ICC_TRANSMIT, $ICC_TRANSMITW
Condition Values Returned | SS$_NORMAL | Normal completion. | | SS$_ACCVIO | Access violation on parameter. | | SS$_BADPARAM | Bad parameter value specified. | | SS$_CLEARED | Remote association closed the link before it was rejected. | | SS$_INSFARG | Too few arguments supplied. | | SS$_IVCHAN | Connection not found or Invalid connection handle. | | SS$_LINKDISCON | The transport layer has initiated disconnect before the Reject could be sent to the requester. | | SS$_TOO_MANY_ARGS | Too many arguments specified. | | SS$_WRONGSTATE | Connection is already open and cannot be rejected. To close the connection, call $ICC_DISCONNECT. |
$ICC_REPLYSends a single message over a connection. This service is used inresponse to the reception of a Request Handle in a previous$ICC_RECEIVE system service.On Alpha systems, this service accepts 64-bit addresses.
FormatSYS$ICC_REPLY conn_handle ,ios_icc ,[astadr] ,[astprm] ,reply_buf,reply_len
C Prototypesys$icc_reply (unsigned int conn_handle, struct _ios_icc *ios_icc, void(*astadr)(__unknown_params), __int64 astprm, char *reply_buf, unsignedint reply_len);
Argumentsconn_handle
| OpenVMS usage: | connection_id | | type: | longword (unsigned) | | access: | read only | | mechanism: | by value |
The handle of the fully established connection.ios_icc
| OpenVMS usage: | io_status_block | | type: | quadword (unsigned) | | access: | modify | | mechanism: | by 32-bit or 64-bit reference (Alpha) | | mechanism: | by 32-bit reference (VAX) |
I/O status block:
 Completion status values: SS$_NORMAL, SS$_EXQUOTA, SS$_INSFMEM, SS$_LINKABORT, SS$_LINKDISCON astadr
| OpenVMS usage: | ast_procedure | | type: | procedure_entry_mask | | access: | call without stack unwinding | | mechanism: | by 32-bit or 64-bit linkage reference (Alpha) | | mechanism: | by 32-bit reference (VAX) |
The AST routine to be executed when the operation completes.astprm
| OpenVMS usage: | user_arg | | type: | quadword (unsigned) (Alpha), longword (unsigned) (VAX) | | access: | read only | | mechanism: | by 64-bit value (Alpha) | | mechanism: | by 32-bit value (VAX) |
The parameter to be passed to the AST routine.reply_buf
| OpenVMS usage: | byte_stream | | type: | character-coded text string | | access: | read only | | mechanism: | by 32-bit or 64-bit reference (Alpha) | | mechanism: | by 32-bit reference (VAX) |
The 32-bit or 64-bit address (on Alpha systems) or the 32-bit address(on VAX systems) of the buffer containing the reply data to be sent.The length of this buffer is specified by the argumentreply_len.reply_len
| OpenVMS usage: | buffer_length | | type: | longword (unsigned) | | access: | read only | | mechanism: | by value |
The length (in bytes) of the reply data to be sent over the connection.This value specifies the length of the bufferreply_buf. ICC segments larger buffers internally.The maximum Reply length is the smaller of the Reply buffer sizesupplied in the $ICC_RECEIVE call, or 1MB. IOS_ICC Argument:
request_handle (input)
| OpenVMS usage: | request_id | | type: | longword (unsigned) | | access: | read only | | mechanism: | by value |
This parameter is passed through the ios_icc. TheRequest/Response handle from the received Transceive request is placedat offset ios_icc$l_replyto_handle of theios_icc.
DescriptionThis service is almost identical to the $ICC_TRANSMIT system service inthat it sends a single message over a connection. The only differenceis that it is used in response to the reception of a Request Handle ina previous Receive Data system service.When completion is signaled by calling the AST (if supplied), the datahas been delivered to the communications system, but not necessarily tothe application at the other end of the connection. The user can reusethe buffer after completion has been signaled. Alternatively, if the synchronous completion option was requested atconnection time, the service may return the optional success status,SS$_SYNCH. When SS$_SYNCH is returned, completion has occurred, and noAST will be delivered. Required Access or Privileges
None. Required Quota
BYTLM (for Reply buffer) Related Services
$ICC_ACCEPT, $ICC_CLOSE_ASSOC, $ICC_CONNECT, $ICC_CONNECTW,$ICC_DISCONNECT, $ICC_DISCONNECTW, $ICC_OPEN_ASSOC, $ICC_RECEIVE,$ICC_RECEIVEW, $ICC_REJECT, $ICC_REPLYW, $ICC_TRANSCEIVE,$ICC_TRANSCEIVEW, $ICC_TRANSMIT, $ICC_TRANSMITW
Condition Values Returned | SS$_NORMAL | Normal completion. | | SS$_ACCVIO | Access violation on parameter. | | SS$_BADPARAM | Bad parameter value specified. | | SS$_EXBYTLM | Insufficient byte count quota. | | SS$_INSFARG | Too few arguments supplied. | | SS$_IVCHAN | Unknown connection specified or invalid connection handle. | | SS$_IVMODE | Attempted to use a connection from a more privileged access mode than the mode in which it was opened. | | SS$_LINKDISCON | An Incoming disconnect event is already in progress. | | SS$_NOSUCHID | The request_handle is invalid. | | SS$_SYNCH | If synchronous mode was requested at connection time, this return value indicates that completion has already occurred and the AST routine, if specified, will not be called. | | SS$_TOO_MANY_ARGS | Too many arguments specified. | | SS$_WRONGSTATE | Connection is in the wrong state for the request. |
$ICC_REPLYWThe Intra-Cluster Communications Reply and Wait service transmits asingle message over a connection in response to a $ICC_TRANSCEIVE[W]request.The $ICC_REPLYW service completes synchronously; that is, it returns tothe caller when the underlying transport layer has released use of thereply buffer. For asynchronous completion, use the $ICC_REPLY service; $ICC_REPLYreturns to the caller as soon as the transmission request has beenqueued to the transport layer, without waiting for notification thatthe transport layer has released control of the data buffer. On Alpha, this service accepts 64-bit addresses.
FormatSYS$ICC_REPLYW conn_handle, ios_icc, [astadr], [astprm], reply_buf,reply_len
C Prototypesys$icc_replyw (unsigned int conn_handle, struct _ios_icc *ios_icc,void (*astadr)(__unknown_params), __int64 astprm, char *reply_buf,unsigned int reply_len);
$ICC_TRANSCEIVESends a single message over a connection and then waits for a reply.On Alpha systems, this service accepts 64-bit addresses.
FormatSYS$ICC_TRANSCEIVE conn_handle ,ios_icc ,[astadr] ,[astprm] ,send_buf,send_len
C Prototypesys$icc_transceive (unsigned int conn_handle, struct _ios_icc *ios_icc,void (*astadr)(__unknown_params), __int64 astprm, char *send_buf,unsigned int send_len);
Argumentsconn_handle
| OpenVMS usage: | connection_id | | type: | longword (unsigned) | | access: | read only | | mechanism: | by value |
The handle of the fully established (open) connection.ios_icc
| OpenVMS usage: | io_status_block | | type: | five longwords (unsigned) | | access: | modify | | mechanism: | by 32-bit or 64-bit reference (Alpha) | | mechanism: | by 32-bit reference (VAX) |
I/O status block:
 Completion status values: SS$_NORMAL, SS$_EXQUOTA, SS$_INSFMEM, SS$_BUFOVFL, SS$_LINKABORT,SS$_LINKDISCON astadr
| OpenVMS usage: | ast_procedure | | type: | procedure_entry_mask | | access: | call without stack unwinding | | mechanism: | by 32-bit or 64-bit linkage reference (Alpha) | | mechanism: | by 32-bit reference (VAX) |
The AST routine to be executed when the operation completes.astprm
| OpenVMS usage: | user_arg | | type: | quadword (unsigned) (Alpha), longword (unsigned) (VAX) | | access: | read only | | mechanism: | by 64-bit value (Alpha) | | mechanism: | by 32-bit value (VAX) |
The parameter to be passed to the AST routine.send_buf
| OpenVMS usage: | byte_stream | | type: | character-coded text string | | access: | read only | | mechanism: | by 32-bit or 64-bit reference (Alpha) | | mechanism: | by 32-bit reference (VAX) |
The 32-bit or 64-bit address (on Alpha systems) or the 32-bit address(on VAX systems) of the buffer containing the data to be sent. Thelength of this buffer is specified by the argumentsend_len.send_len
| OpenVMS usage: | buffer size | | type: | longword (unsigned) | | access: | read only | | mechanism: | by value |
The length (in bytes) of the data to be sent over the connection. Thisvalue specifies the length of the buffer send_buf.IOS_ICC Arguments:
returned_data_len (output)
| OpenVMS usage: | longword_unsigned | | type: | longword (unsigned) | | access: | write only | | mechanism: | by value |
This parameter is passed through the ios_icc. The$ICC_TRANSCEIVE service writes the actual length (in bytes) of thereply data received into offset ios_icc$l_txrcv_len ofthe ios_icc. This value represents how much data inreply_buf was returned by the target application.reply_buf (input)
| OpenVMS usage: | byte_stream | | type: | character-coded text string | | access: | write only | | mechanism: | by 32-bit or 64-bit reference (Alpha) | | mechanism: | by 32-bit reference (VAX) |
This parameter is passed through the ios_icc. The32-bit or 64-bit address (on Alpha systems) or the 32-bit address (onVAX systems) of the buffer available to receive the incoming replymessage is placed in offset ios_icc$a_reply_buffer ofthe ios_icc.reply_buf_len (input)
| OpenVMS usage: | buffer_size | | type: | longword (unsigned) | | access: | read only | | mechanism: | by value |
This parameter is passed through the ios_icc. Thelength (in bytes) of the buffer to receive the reply message. Thisvalue specifies the length of the buffer reply_buf.This value is placed in offset ios_icc$l_txreply_lenof the ios_icc.
DescriptionThis service sends a single message over a connection and then waitsfor a reply. When completion is signaled by calling the AST (ifsupplied), the data has been delivered to the application at the otherend of the connection and that application has delivered a reply, nowpresent in the reply buffer. The user can reuse the send and replybuffers after completion.For efficiency reasons, the number of parameters on this routine hasbeen limited to six parameters. Three additional parameters are passedby the ios_icc data structure. Required Access or Privileges
None. Required Quota
BYTLM (Send and Reply buffers) Related Services
$ICC_ACCEPT, $ICC_CLOSE_ASSOC, $ICC_CONNECT, $ICC_CONNECTW,$ICC_DISCONNECT, $ICC_DISCONNECTW, $ICC_OPEN_ASSOC, $ICC_RECEIVE,$ICC_RECEIVEW, $ICC_REJECT, $ICC_REPLY, $ICC_REPLYW, $ICC_TRANSCEIVEW,$ICC_TRANSMIT, $ICC_TRANSMITW
Condition Values Returned | SS$_NORMAL | Normal completion. | | SS$_ACCVIO | Access violation on parameter. | | SS$_BADPARAM | Bad parameter value specified. | | SS$_EXBYTLM | Insufficient byte count quota. | | SS$_INSFARG | Too few arguments were supplied. | | SS$_INSFMEM | Insufficient process or system memory to complete the request. | | SS$_IVCHAN | Unknown connection specified or invalid connection handle. | | SS$_IVMODE | Attempted to use a connection from a more privileged access mode than the mode in which it was opened. | | SS$_LINKDISCON | An Incoming disconnect event is in progress. | | SS$_SYNCH | If synchronous mode was requested at connection time, this return value indicates that completion has already occurred and the AST routine, if specified, will not be called. | | SS$_TOO_MANY_ARGS | Too many arguments were specified. | | SS$_WRONGSTATE | Connection is in wrong state for request. |
$ICC_TRANSCEIVEWSends a single message over a connection and waits for a reply.The $ICC_TRANSCEIVEW service completes synchronously; that is, itreturns to the caller when the data from the reply is available. For asynchronous completion, use the $ICC_TRANSCEIVE service;$ICC_TRANSCEIVE returns to the caller when the transmit portion of thetranceive request has been queued to the transport layer, but withoutwaiting for notification that the transport layer has released controlof the data buffer or for the reply data from the receiving end of theconnection. On Alpha, this service accepts 64-bit addresses.
FormatSYS$ICC_TRANSCEIVEWconn_handle ,ios_icc ,[astadr] ,[astprm] ,send_buf ,send_len
C Prototypesys$icc_transceivew (unsigned int conn_handle, struct _ios_icc*ios_icc, void (*astadr)(__unknown_params), __int64 astprm, char*send_buf, unsigned int send_len);
$ICC_TRANSMITSends a single message over a connection.On Alpha systems, this service accepts 64-bit addresses.
FormatSYS$ICC_TRANSMIT conn_handle ,ios_icc ,[astadr] ,[astprm] ,send_buf,send_len
C Prototypesys$icc_transmit (unsigned int conn_handle, struct _ios_icc *ios_icc,void (*astadr)(__unknown_params), __int64 astprm, char *send_buf,unsigned int send_len);
Argumentsconn_handle
| OpenVMS usage: | connection_id | | type: | longword (unsigned) | | access: | read only | | mechanism: | by value |
The handle of the fully established (open) connection to send the dataover.ios_icc
| OpenVMS usage: | ios_status_block | | type: | structure IOS_ICC | | access: | write only | | mechanism: | by 32-bit or 64-bit reference (Alpha) | | mechanism: | by 32-bit reference (VAX) |
I/O status block:
 Completion status values: SS$_NORMAL, SS$_EXQUOTA, SS$_INSFMEM, SS$_LINKABORT, SS$_LINKDISCON astadr
| OpenVMS usage: | ast_procedure | | type: | procedure_entry_mask | | access: | call without stack unwinding | | mechanism: | by 32-bit or 64-bit linkage reference (Alpha) | | mechanism: | by 32-bit reference (VAX) |
The AST routine to be executed when the operation completes.astprm
| OpenVMS usage: | user_arg | | type: | quadword (unsigned) (Alpha), longword (unsigned) (VAX) | | access: | read only | | mechanism: | by 64-bit value (Alpha) | | mechanism: | by 32-bit value (VAX) |
The parameter to be passed to the AST routine.send_buf
| OpenVMS usage: | byte_stream | | type: | character-coded text string | | access: | read only | | mechanism: | by 32-bit or 64-bit reference (Alpha) | | mechanism: | by 32-bit reference (VAX) |
The 32-bit or 64-bit address (on Alpha systems) or the 32-bit address(on VAX systems) of the buffer containing the data to be sent. Thelength of this buffer is specified by the argumentsend_len.send_len
| OpenVMS usage: | buffer_length | | type: | longword (unsigned) | | access: | read only | | mechanism: | by value |
The length (in bytes) of the data to be sent over the connection. Thisvalue specifies the length of the buffer send_buf. Themaximum transmission size is 1MB.
DescriptionThis service sends a single message over a connection. When completionis signalled by calling the AST (if supplied), the data has beendelivered to the communications system, but not necessarily to thesystem or application at the other end of the connection. Aftercompletion, the user can reuse the buffer.Alternatively, if the synchronous completion option was requested atconnection time, the service may return the optional success status,SS$_SYNCH. When SS$_SYNCH is returned, completion has occurred, and noAST will be delivered. Required Access or Privileges
None. Required Quota
BYTLM (send_buf) Related Services
$ICC_ACCEPT, $ICC_CLOSE_ASSOC, $ICC_CONNECT, $ICC_CONNECTW,$ICC_DISCONNECT, $ICC_DISCONNECTW, $ICC_OPEN_ASSOC, $ICC_RECEIVE,$ICC_RECEIVEW, $ICC_REJECT, $ICC_REPLY, $ICC_REPLYW, $ICC_TRANSCEIVE,$ICC_TRANSCEIVEW, $ICC_TRANSMITW
Condition Values Returned | SS$_NORMAL | Normal completion. | | SS$_ACCVIO | Access violation on parameter. | | SS$_BADPARAM | Bad parameter value specified. | | SS$_EXBYTLM | Insufficient byte count quota. | | SS$_INSFARG | Too few arguments were supplied. | | SS$_INSFMEM | Insufficient process or system memory to complete the request. | | SS$_IVCHAN | Unknown connection specified or invalid connection handle. | | SS$_IVMODE | Attempted to use a connection from a more privileged access mode than the mode in which it was opened. | | SS$_LINKDISCON | An Incoming disconnect event is in progress. | | SS$_SYNCH | If synchronous mode was requested at connection time, this return value indicates that completion has already occurred and the AST routine, if specified, will not be called. | | SS$_TOO_MANY_ARGS | Too many arguments were specified. | | SS$_WRONGSTATE | Connection is in the wrong state for the request. |
$ICC_TRANSMITWSends a single message over a connection.The $ICC_TRANSMITW service completes synchronously; that is, it returnsto the caller when the underlying transport layer has released use ofthe Transmit buffer. This does not mean that the data has been receivedby the partner application. For asynchronous completion, use the $ICC_TRANSMIT service. The$ICC_TRANSMIT service returns to the caller as soon as the transmissionrequest has been queued to the transport layer, without waiting fornotification that the transport layer has released control of the databuffer. On Alpha, this service accepts 64-bit addresses.
FormatSYS$ICC_TRANSMITW conn_handle ,ios_icc ,[astadr] ,[astprm] ,send_buf,send_len
C Prototypesys$icc_transmitw (unsigned int conn_handle, struct _ios_icc *ios_icc,void (*astadr)(__unknown_params), __int64 astprm, char *send_buf,unsigned int send_len);
$IDTOASCTranslates the specified identifier value to its identifier name.On Alpha systems, this service accepts 64-bit addresses.
FormatSYS$IDTOASC id ,[namlen] ,[nambuf] ,[resid] ,[attrib] ,[contxt]
C Prototypeint sys$idtoasc (unsigned int id, unsigned short int *namlen, void*nambuf, unsigned int *resid, unsigned int *attrib, unsigned int*contxt);
Argumentsid
| OpenVMS usage: | rights_id | | type: | longword (unsigned) | | access: | read only | | mechanism: | by value |
Binary identifier value translated by $IDTOASC. The idargument is a longword containing the binary value of the identifier.To determine the identifier names of all identifiers in the rightsdatabase, you specify id as --1 and call $IDTOASCrepeatedly until it returns the status code SS$_NOSUCHID. Theidentifiers are returned in alphabetical order.namlen
| OpenVMS usage: | word_unsigned | | type: | word (unsigned) | | access: | write only | | mechanism: | by 32- or 64-bit reference (Alpha) | | mechanism: | by 32-bit reference (VAX) |
Number of characters in the identifier name translated by $IDTOASC. Thenamlen argument is the 32- or 64-bit address (on Alphasystems) or the 32-bit address (on VAX systems) of a word containingthe length of the identifier name written to nambuf.nambuf
| OpenVMS usage: | char_string | | type: | character-coded text string | | access: | write only | | mechanism: | by 32- or 64-bit descriptor--fixed-length string descriptor (Alpha) | | mechanism: | by 32-bit descriptor--fixed-length string descriptor (VAX) |
Identifier name text string returned when $IDTOASC completes thetranslation. The nambuf argument is the 32- or 64-bitaddress (on Alpha systems) or the 32-bit address (on VAX systems) of adescriptor pointing to the buffer in which the identifier name iswritten.resid
| OpenVMS usage: | rights_id | | type: | longword (unsigned) | | access: | write only | | mechanism: | by 32- or 64-bit reference (Alpha) | | mechanism: | by 32-bit reference (VAX) |
Identifier value of the identifier name returned innambuf. The resid argument is the 32-or 64-bit address (on Alpha systems) or the 32-bit address (on VAXsystems) of a longword containing the 32-bit code of the identifier.attrib
| OpenVMS usage: | mask_longword | | type: | longword (unsigned) | | access: | write only | | mechanism: | by by 32- or 64-bit reference (Alpha) | | mechanism: | by 32-bit reference (VAX) |
Mask of attributes associated with the identifier returned inresid. The attrib argument is the 32-or 64-bit address (on Alpha systems) or the 32-bit address (on VAXsystems) of a longword containing the attribute mask.Symbol values are offsets to the bits within the longword. You can alsoobtain the values as masks with the appropriate bit set using theprefix KGB$M rather than KGB$V. The following symbols for each bitposition are defined in the system macro library ($KGBDEF): | Bit Position | Meaning When Set | | KGB$V_DYNAMIC | Allows holders of the identifier to remove it from or add it to the process rights list using the DCL command SET RIGHTS_LIST. | | KGB$V_NAME_HIDDEN | Allows holders of an identifier to have it translated, either from binary to ASCII or vice versa, but prevents unauthorized users from translating the identifier. | | KGB$V_NOACCESS | Makes any access rights of the identifier null and void. This attribute is intended as a modifier for a resource identifier or the Subsystem attribute. | | KGB$V_RESOURCE | Allows holders of an identifier to charge disk space to the identifier. It is used only for file objects. | | KGB$V_SUBSYSTEM | Allows holders of the identifier to create and maintain protected subsystems by assigning the Subsystem ACE to the application images in the subsystem. | contxt
| OpenVMS usage: | context | | type: | longword (unsigned) | | access: | modify | | mechanism: | by 32- or 64-bit reference (Alpha) | | mechanism: | by 32-bit reference (VAX) |
Context value used when repeatedly calling $IDTOASC. Thecontxt argument is the 32- or 64-bit address (on Alphasystems) or the 32-bit address (on VAX systems) of a longword usedwhile $IDTOASC searches for all identifiers. The context value must beinitialized to the value 0, and the resulting context of each call to$IDTOASC must be presented to each subsequent call. Aftercontxt is passed to $IDTOASC, you must not modify itsvalue.
DescriptionThe Translate Identifier to Identifier Name service translates thespecified binary identifier value to an identifier name. While theprimary purpose of this service is to translate the specifiedidentifier to its name, you can also use it to find all identifiers inthe rights database. Owner or read access to the rights database isrequired. To determine all the identifiers, call $IDTOASC repeatedlyuntil it returns the status code SS$_NOSUCHID. When SS$_NOSUCHID isreturned, $IDTOASC has returned all the identifiers, cleared thecontext value, and deallocated the record stream.If you complete your calls to $IDTOASC before SS$_NOSUCHID is returned,use $FINISH_RDB to clear the context value and deallocate the recordstream. When you use wildcards with this service, the records are returned inidentifier name order. Required Access or Privileges
None, unless the id argument is NAME_HIDDEN, in whichcase you must hold the identifier or have read access to the rightslist. Required Quota
None Related Services
$ADD_HOLDER, $ADD_IDENT, $ASCTOID, $CHECK_ACCESS, $CHKPRO, $CREATE_RDB,$ERAPAT, $FIND_HELD, $FIND_HOLDER, $FINISH_RDB, $FORMAT_ACL,$FORMAT_AUDIT, $GET_SECURITY, $GRANTID, $HASH_PASSWORD, $MOD_HOLDER,$MOD_IDENT, $MTACCESS, $PARSE_ACL, $REM_HOLDER, $REM_IDENT, $REVOKID,$SET_SECURITY
Condition Values Returned | SS$_NORMAL | The service completed successfully. | | SS$_ACCVIO | The namlen, nambuf, resid, attrib, or contxt argument cannot be written by the caller. | | SS$_INSFMEM | The process dynamic memory is insufficient for opening the rights database. | | SS$_IVCHAN | The contents of the context longword are not valid. | | SS$_IVIDENT | The specified identifier is of invalid format. | | SS$_NOIOCHAN | No more rights database context streams are available. | | SS$_NORIGHTSDB | The rights database does not exist. | | SS$_NOSUCHID | The specified identifier name does not exist in the rights database, or the entire rights database has been searched if the ID is --1. |
Because the rights database is an indexed file that you access withOpenVMS RMS, this service can also return RMS status codes associatedwith operations on indexed files. For descriptions of these statuscodes, refer to the OpenVMS Record Management Services Reference Manual.
|
