Difference between revisions of "DosQSysInfo"
m (Ak120 moved page DosQSysInfo (Legacy) to DosQSysInfo) |
m |
||
Line 1: | Line 1: | ||
− | + | This call returns values of static system variables. | |
− | This | + | |
− | + | This function has been renamed to "[[DosQuerySysInfo]]". | |
− | + | ||
− | This | + | |
==Syntax== | ==Syntax== | ||
− | + | DosQSysInfo (Index, DataBuf, DataBufLen) | |
− | DosQSysInfo | + | |
− | |||
− | |||
==Parameters== | ==Parameters== | ||
− | ; | + | ;Index (USHORT) - input : Ordinal of the system variable to return. |
− | + | :Index = 0 indicates maximum path length. The maximum path length is returned in the first word of the DataBuf. | |
− | Index = 0 indicates maximum path length. The maximum path length is returned in the first word of the DataBuf. | + | ;DataBuf (PBYTE) - output : Address where the system returns the variable value. |
− | + | ;DataBufLen (USHORT) - input : Length of the data buffer. | |
− | ; DataBuf (PBYTE) - output : Address where the system returns the variable value. | + | |
− | + | ||
− | ; DataBufLen (USHORT) - input : Length of the data buffer. | + | |
==Return Code== | ==Return Code== | ||
rc (USHORT) - return | rc (USHORT) - return | ||
− | |||
Return code descriptions include: | Return code descriptions include: | ||
− | + | * 0 NO_ERROR | |
− | * 0 | + | * 87 ERROR_INVALID_PARAMETER |
− | * 87 | + | * 111 ERROR_BUFFER_OVERFLOW |
− | * 111 | + | |
==Remarks== | ==Remarks== | ||
Line 35: | Line 24: | ||
DosQSysInfo returns the maximum path length supported by the file system currently installed. The path length includes the drive specifier (d:), the leading "\" and the trailing null character. | DosQSysInfo returns the maximum path length supported by the file system currently installed. The path length includes the drive specifier (d:), the leading "\" and the trailing null character. | ||
− | The value returned by DosQSysInfo can be used to allocate buffers for storing path names returned by requests, for example, to DosFindFirst and DosFindNext. | + | The value returned by DosQSysInfo can be used to allocate buffers for storing path names returned by requests, for example, to [[DosFindFirst]] and [[DosFindNext]]. |
==Example Code== | ==Example Code== | ||
Line 63: | Line 52: | ||
Returns WORD | Returns WORD | ||
</PRE> | </PRE> | ||
+ | |||
==Related Functions== | ==Related Functions== | ||
* | * | ||
− | + | [[Category:Dos]] | |
− | [[Category: | + |
Revision as of 07:18, 18 February 2017
This call returns values of static system variables.
This function has been renamed to "DosQuerySysInfo".
Contents
Syntax
DosQSysInfo (Index, DataBuf, DataBufLen)
Parameters
- Index (USHORT) - input
- Ordinal of the system variable to return.
- Index = 0 indicates maximum path length. The maximum path length is returned in the first word of the DataBuf.
- DataBuf (PBYTE) - output
- Address where the system returns the variable value.
- DataBufLen (USHORT) - input
- Length of the data buffer.
Return Code
rc (USHORT) - return
Return code descriptions include:
- 0 NO_ERROR
- 87 ERROR_INVALID_PARAMETER
- 111 ERROR_BUFFER_OVERFLOW
Remarks
An OS/2 application may want to reference file objects managed by an installable file system that supports long file names. Because some installable file systems may support longer names than others, an application should issue DosQSysInfo upon initialization.
DosQSysInfo returns the maximum path length supported by the file system currently installed. The path length includes the drive specifier (d:), the leading "\" and the trailing null character.
The value returned by DosQSysInfo can be used to allocate buffers for storing path names returned by requests, for example, to DosFindFirst and DosFindNext.
Example Code
C Binding
#define INCL_DOSFILEMGR USHORT rc = DosQSysInfo(Index, DataBuf, DataBufLen); USHORT Index; /* Which variable */ PBYTE DataBuf; /* System information (returned) */ USHORT DataBufLen; /* Data buffer size */ USHORT rc; /* return code */
MASM Binding
EXTRN DosQSysInfo:FAR INCL_DOSFILEMGR EQU 1 PUSH WORD Index ;Which variable PUSH@ OTHER DataBuf ;System information (returned) PUSH WORD DataBufLen ;Data buffer size CALL DosQSysInfo Returns WORD