xRPG Core Library - Command Procedures: rtvMemberD()
Call QUSRMBRD to Retrieve Member Description
Usage:
errorCode = RtvMemberD( MbrName : FileName : LibName : DataLevel : { DataStructurePointer } );
As of version 1.05 there is an optional fifth parm. This parm should be a pointer to a data structure: the data structure needs to be
the correct DS for the requested format level. These data structures are found in the /copy rpgnextlib/qrpglesrc,ds_rtvmbrd. There are three
data strucutres included, one for each format level (as specified in parameter four):
- 'BASIC' - QBasic
- 'EXPANDED' - QExp
- 'FULL' = QFull
*NOTE: Each of these data structures is defined as "Qualified" and as such must be addressed in the correct format: DSNAME.subFieldName. Reference the /copy
for the subfield names.
In order to populate these data structures you must include the /copy member in your D-Specs and pass a pointer in the fifth parameter position to the data structure that matches your desired Data Level (parameter 4). EX:
/copy rpgnextlib/qrpglesrc,ds_rtvmbrd
/free
errorCode = rtvMemberD( memberName : fileName : libraryName : 'basic' : %addr( QBasic ) );
// The QBasic data structure is now populated.
/end-free
More information on the QUSRMBRD API and the data structures can be found at the
Infocenter.
| mbrName |
10A |
Value |
Req |
The member name, '*FIRST', or '*LAST'. |
| fileName |
10A |
Value |
Req |
The file Name. |
| libraryName |
10A |
Value |
Req |
TheLlbrary Name, '*CURLIB', or '*LIBL'. |
| dataLevel |
10A |
Value |
Req |
'BASIC', 'EXPANDED', or 'FULL'. |
| dataStructurePointer |
* |
Const |
Opt |
A pointer to the related data structure for the requested format. |
| Returns: |
1A |
n/a |
n/a |
ErrorCode '0' for no error ; '1' indicates an error. |