Jump to content

DosSMGetStatus: Difference between revisions

From EDM2
Created page with "image:legacy.png ==Description== Return status of screen groups. This can only be called by the shell that owns the Session Manager. ==Syntax== <PRE> APIRET16 Pascal far..."
 
Ak120 (talk | contribs)
mNo edit summary
 
(4 intermediate revisions by 2 users not shown)
Line 1: Line 1:
[[image:legacy.png]]
==Description==
Return status of screen groups. This can only be called by the shell that owns the Session Manager.
Return status of screen groups. This can only be called by the shell that owns the Session Manager.


==Syntax==
==Syntax==
<PRE>
DOSSMGETSTATUS (func, data)
APIRET16 Pascal far DOSSMGETSTATUS(short func,void far* data)
 
</PRE>
==Parameters==
==Parameters==
; func
;func (short):function code
    function code
::0: return complete data
    =0: return complete data
::1: return complete data (different ordering)
    =1 return complete data (different ordering)
::2: return header data only (query how much space is needed)
    =2: return header data only (query how much space is needed)
::3: return specified screen group only
    =3: return specified screen group only
;data (void far*):structure to return data
 
; data
    structure to return data
 
         struct header {
         struct header {
             short length_of_header; /*8 bytes*/
             short length_of_header; /*8 bytes*/
Line 25: Line 17:
             short length_of_entry;
             short length_of_entry;
         };
         };
 
         struct entry { /*for each screengroup one structure*/
         struct entry { /*for each screengroup one structure*/
             short screen_group_number;
             short screen_group_number;
Line 37: Line 29:
             short type_of_group (FS/VIO/PM);
             short type_of_group (FS/VIO/PM);
         };
         };


==Return Code==
==Return Code==
  APIRET16 Pascal far


==Remarks==
[[Category:Dos]]
 
 
==Example Code==
 
<PRE>
 
</PRE>
 
==Related Functions==
*
 
 
[[Category:The OS/2 API Project]]

Latest revision as of 05:23, 9 November 2018

Return status of screen groups. This can only be called by the shell that owns the Session Manager.

Syntax

DOSSMGETSTATUS (func, data)

Parameters

func (short)
function code
0: return complete data
1: return complete data (different ordering)
2: return header data only (query how much space is needed)
3: return specified screen group only
data (void far*)
structure to return data
       struct header {
           short length_of_header; /*8 bytes*/
           short screen_group;     /*function 3*/
           short next_active_screengroup;
           short length_of_entry;
       };

       struct entry { /*for each screengroup one structure*/
           short screen_group_number;
           char screen_group_title[32];
           short is_selected;
           short child_screengroup;
           short type_of_screengroup;
           short parent_of_child;
           short next_child;
           short parent_screengroup;
           short type_of_group (FS/VIO/PM);
       };

Return Code

 APIRET16 Pascal far