Retrieve Scan Signature (QP0LRTSG) API
Syntax
#include <qp0lrtsg.h> void QP0LRTSG (void *ScanKey_Ptr, void *ScanSign_Ptr, void *Error_Code_Ptr);Default Public Authority: *USE
Threadsafe: Yes
The Retrieve Scan Signature (QP0LRTSG) API retrieves the scan key signature associated with a specific scan key. The scan key and scan key signature are used with the integrated file system scan-related exit points to indicate a software level which is to be associated with the exit points' exit program registrations.
The integrated file system scan-related exit points are:
- Integrated File System Scan on Close Exit Programs
- Integrated File System Scan on Open Exit Programs.
To change the scan key signature associated with a specific scan key, see Change Scan Signature (QP0LCHSG) API. For more information about the integrated file system scan processing, see the Integrated file system topic collection.
Parameters
- ScanKey_Ptr
- (Input) A pointer to a 20-byte character string that identifies the scan
key whose scan key signature is being retrieved. The scan key is one that was
specified when an exit program was registered or added to any of the integrated
file system scan-related exit points.
If the scan key has not yet been registered with any scan-related exit program, CPFA0EA is sent.
See Scan Key List and Scan Key Signatures in Integrated File System Scan on Open Exit Program for more information.
- ScanSign_Ptr
- (Output) A pointer to the 12-byte character string that identifies the scan
key signature that is currently associated with the specified scan
key.
See Scan Key List and Scan Key Signatures in Integrated File System Scan on Open Exit Program for more information.
- Error_Code_Ptr
- (Input/Output) Pointer to an error code structure to receive error
information. See Error code parameter for
more information.
Authorities
None.
Error Messages
The following messages may be sent from this function:
Message ID | Error Message Text |
---|---|
CPF3C36 E | Number of parameters, &1, entered for this API was not valid. |
CPF3CF1 E | Error code parameter not valid. |
CPF3CF2 E | Error(s) occurred during running of &1 API. |
CPF9872 E | Program or service program &1 in library &2 ended. Reason code &3. |
CPFA0D4 E | File system error occurred. Error number &1. |
CPFA0EA E | Scan key &1 does not exist. |
Related Information
- The <qp0lrtsg.h> file (see Header Files for UNIX®-Type Functions)
- Integrated File System Scan on Close Exit Program
- Integrated File System Scan on Open Exit Programs
- Change Scan Signature (QP0LCHSG) API
- Qp0lGetAttr()--Get Attributes
- Qp0lSetAttr()--Set Attributes
Example
See Change Scan Signature (QP0LCHSG) API for an example showing a call to the Change Scan Signature (QP0LCHSG) and the Retrieve Scan Signature (QP0LRTSG) APIs.
API introduced: V5R3
[ Back to top | Integrated File System APIs | APIs by category ]