FSH QSYSINFO: Difference between revisions
| (One intermediate revision by the same user not shown) | |||
| Line 1: | Line 1: | ||
This function queries the system about dynamic system variables and static system variables not returned by DosQSysInfo. | This function queries the system about dynamic system variables and static system variables not returned by DosQSysInfo. | ||
==Syntax== | ==Syntax== | ||
FSH_QSYSINFO(index, pData, cbData) | |||
==Parameters== | ==Parameters== | ||
;index: is the variable to return. | ;index: is the variable to return. | ||
:*index == 1 indicates maximum sector size. | :*index == 1 indicates maximum sector size. | ||
:*index == 2 indicates process identity. The data returned will be as follows: | :*index == 2 indicates process identity. The data returned will be as follows: | ||
::{| | |||
struct { | | | ||
struct { | |||
unsigned short PID; | unsigned short PID; | ||
unsigned short UID; | unsigned short UID; | ||
unsigned short PDB; | unsigned short PDB; | ||
} | } | ||
|} | |||
:*index == 3 indicates absolute thread number for the current thread. This will be returned in an unsigned short field. | :*index == 3 indicates absolute thread number for the current thread. This will be returned in an unsigned short field. | ||
:*index == 4 indicates verify on write flag for the process. This will be returned in an unsigned char (byte) field. Zero means verify is off, non-zero means it is on. | |||
:*index == 4 indicates verify on write flag for the process. This will be returned in an unsigned char (byte) field. Zero means verify is off, non-zero means it is on. | ;pData: is the long address to the data area. | ||
;cbData: is the length of the data area. | |||
==Returns== | ==Returns== | ||
If no error is detected, a zero error code is returned. If an error is detected, one of the following error codes is returned: | If no error is detected, a zero error code is returned. If an error is detected, one of the following error codes is returned: | ||
* ERROR_INVALID_PARAMETER the index is invalid. | |||
* ERROR_BUFFER_OVERFLOW the specified buffer is too short for the returned data. | |||
==Calling Sequence== | ==Calling Sequence== | ||
<PRE> | <PRE> | ||
| Line 35: | Line 34: | ||
unsigned short cbData; | unsigned short cbData; | ||
</PRE> | </PRE> | ||
==Remarks== | ==Remarks== | ||
;Note: | ;Note: OS/2 does not validate input parameters. An FSD, therefore, should call FSH_PROBEBUF where appropriate. | ||
[[Category:IFS Interfaces]] | [[Category:IFS Interfaces]] | ||
{{DISPLAYTITLE:FSH_QSYSINFO}} | {{DISPLAYTITLE:FSH_QSYSINFO}} | ||
Latest revision as of 05:01, 20 February 2020
This function queries the system about dynamic system variables and static system variables not returned by DosQSysInfo.
Syntax
FSH_QSYSINFO(index, pData, cbData)
Parameters
- index
- is the variable to return.
- index == 1 indicates maximum sector size.
- index == 2 indicates process identity. The data returned will be as follows:
struct { unsigned short PID; unsigned short UID; unsigned short PDB; }
- index == 3 indicates absolute thread number for the current thread. This will be returned in an unsigned short field.
- index == 4 indicates verify on write flag for the process. This will be returned in an unsigned char (byte) field. Zero means verify is off, non-zero means it is on.
- pData
- is the long address to the data area.
- cbData
- is the length of the data area.
Returns
If no error is detected, a zero error code is returned. If an error is detected, one of the following error codes is returned:
- ERROR_INVALID_PARAMETER the index is invalid.
- ERROR_BUFFER_OVERFLOW the specified buffer is too short for the returned data.
Calling Sequence
int far pascal FSH_QSYSINFO(index, pData, cbData) unsigned short index; char far * pData; unsigned short cbData;
Remarks
- Note
- OS/2 does not validate input parameters. An FSD, therefore, should call FSH_PROBEBUF where appropriate.