Jump to content

DosQSysInfo: Difference between revisions

From EDM2
Ak120 (talk | contribs)
m Ak120 moved page DosQSysInfo (Legacy) to DosQSysInfo
Ak120 (talk | contribs)
mNo edit summary
Line 1: Line 1:
[[image:legacy.png]]
This call returns values of static system variables.
This function has been renamed to "[[OS2_API:CPI:DosQuerySysInfo|DosQuerySysInfo]]". [https://books.google.com.ec/books?id=u7WbsmbttwYC&pg=PT372&lpg=PT372&dq#v=onepage&q&f=false]


 
This function has been renamed to "[[DosQuerySysInfo]]".
==Description==
This call returns values of static system variables.


==Syntax==
==Syntax==
<PRE>
  DosQSysInfo (Index, DataBuf, DataBufLen)
  DosQSysInfo


    (Index, DataBuf, DataBufLen)
</PRE>
==Parameters==
==Parameters==
; Index (USHORT) - input : Ordinal of the system variable to return.
;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         NO_ERROR
* 87 ERROR_INVALID_PARAMETER  
* 87         ERROR_INVALID_PARAMETER  
* 111 ERROR_BUFFER_OVERFLOW
* 111       ERROR_BUFFER_OVERFLOW


==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:The OS/2 API Project]]

Revision as of 09:18, 18 February 2017

This call returns values of static system variables.

This function has been renamed to "DosQuerySysInfo".

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

Related Functions