RVDE7

VDE
VDE
Reference Manual


 q
Previous[ Contents] Index


R

VDE$ShowFacilities



CVDE$ShowFacilities displays facilities within the specified stream.



Format

C

VDE$ShowFacilities context, itemlist, callback, callbackparam, flags




Arguments



context


                
 VMS usage:
type:  longword integer (signed)
access:  read-write
 mechanism:  by reference

=This is the address of a longword used by VDE to reference a -context structure. This longword is optional.

GIf this argument is specified, the first call must pass in the address <of a longword zero. Once a VDE routine has been called, the @contents of the address referenced by this longword must not be modified by the caller.

itemlist


                
 VMS usage:
type:  itemlist
access:  read only
 mechanism:  by reference

9This is the address of an array of OpenVMS itemlist data structures.

 

" 
struct VDEIL3     { )    unsigned short int VDE$W_ITEMLENGTH; '    unsigned short int VDE$W_ITEMCODE;     char *VDE$A_ITEMPOINTER; '    short int *VDE$A_ITEMRETURNLENGTH;     }; 



FThe itemlist array must be terminated by a null-filled itemlist entry.

`See Table C-1 for a list of the itemlist codes.

callback


                
 VMS usage:
type:  function
access:  read only
 mechanism:  by reference

BThe callback routine is called to process individual entries in a Fdisplay operation. It is passed an itemlist containing information on Geach individual entry---the itemlist passed to the callback routine is Adistinct and seperate from the itemlist passed into the original Crequest, though it does contain a pointer to the caller's original itemlist.

>An example of the declaration of the callback routine follows:

 

" 
7int VDE$InterfaceTestShow( int, struct VDEIL3 *, int ) 



EThe first argument is not currently used. The second argument is the Faddress of the itemlist. The third argument is the callback parameter.

4The callback should return a successful status code.

callbackparam


                
 VMS usage:
type:  longword
access:  read only
 mechanism:  by value

BThe callback parameter is a longword value passed to the callback =routine. It is not interpreted by VDE. The interpretation of #the longword is left to the caller.

flags


                
 VMS usage:
type:  longword integer (signed)
access:  read-only
 mechanism:  by value

GThis is a bitflag and all unused bits should be specified as zero. The Donly bit currently defined is VDE$V_CI_FLAG_SIGNAL: this bit causes >internal signals to generate text messages to SYS$OUTPUT: and CSYS$ERROR:. If clear---the default---no messages will be displayed.



Description

HVDE$ShowFacilities displays the facilities within the specified library Dand stream. Each facility located results in a call to the callback Broutine. To perform the operation, the library and stream must be specified.

5As parameters specified to VDE callback routines are F"sticky", if a required parameter is not specified, it will 4be defaulted to the value used on a preceeding call.




Example

 #    

 
  
      

      
"      
          int retstat;     int n;     struct VDEIL3 itmlst[20]; B    $DESCRIPTOR( library, "VDE$RESD2$:[VDE-MOTIF-DEMO.TSTLIB]" ); #    $DESCRIPTOR( stream, "MAIN" ); <    int VDE$InterfaceTestShow( int, struct VDEIL3 *, int );      n = 0; ?    itmlst[n].VDE$W_ItemCode                = VDE$_CI_LIBRARY; D    itmlst[n].VDE$W_ItemLength              = library.dsc$w_length; E    itmlst[n].VDE$A_ItemPointer             = library.dsc$a_pointer; 1    itmlst[n++].VDE$A_ItemReturnLength      = 0;  >    itmlst[n].VDE$W_ItemCode                = VDE$_CI_STREAM; C    itmlst[n].VDE$W_ItemLength              = stream.dsc$w_length; D    itmlst[n].VDE$A_ItemPointer             = stream.dsc$a_pointer; 1    itmlst[n++].VDE$A_ItemReturnLength      = 0;  1    itmlst[n].VDE$W_ItemCode                = 0; 1    itmlst[n].VDE$W_ItemLength              = 0; 1    itmlst[n].VDE$A_ItemPointer             = 0; 1    itmlst[n++].VDE$A_ItemReturnLength      = 0;  O    retstat = VDE$ShowFacilities( 0, itmlst, VDE$InterfaceTestShow, 0x0048B ); 



+this section under construction...


N

VDE$ShowProjects



?VDE$ShowProjects displays projects within the specified stream.



Format

G

VDE$ShowProjects context, itemlist, callback, callbackparam, flags 




Arguments



context


                
 VMS usage:
type:  longword integer (signed)
access:  read-write
 mechanism:  by reference

=This is the address of a longword used by VDE to reference a -context structure. This longword is optional.

GIf this argument is specified, the first call must pass in the address <of a longword zero. Once a VDE routine has been called, the @contents of the address referenced by this longword must not be modified by the caller.

itemlist


                
 VMS usage:
type:  itemlist
access:  read only
 mechanism:  by reference

9This is the address of an array of OpenVMS itemlist data structures.

 

" 
struct VDEIL3     { )    unsigned short int VDE$W_ITEMLENGTH; '    unsigned short int VDE$W_ITEMCODE;     char *VDE$A_ITEMPOINTER; '    short int *VDE$A_ITEMRETURNLENGTH;     }; 



FThe itemlist array must be terminated by a null-filled itemlist entry.

`See Table C-1 for a list of the itemlist codes.

callback


                
 VMS usage:
type:  function
access:  read only
 mechanism:  by reference

BThe callback routine is called to process individual entries in a Fdisplay operation. It is passed an itemlist containing information on Geach individual entry---the itemlist passed to the callback routine is Adistinct and seperate from the itemlist passed into the original Crequest, though it does contain a pointer to the caller's original itemlist.

>An example of the declaration of the callback routine follows:

 

" 
7int VDE$InterfaceTestShow( int, struct VDEIL3 *, int ) 



EThe first argument is not currently used. The second argument is the Faddress of the itemlist. The third argument is the callback parameter.

4The callback should return a successful status code.

callbackparam


                
 VMS usage:
type:  longword
access:  read only
 mechanism:  by value

BThe callback parameter is a longword value passed to the callback =routine. It is not interpreted by VDE. The interpretation of #the longword is left to the caller.

flags


                
 VMS usage:
type:  longword integer (signed)
access:  read-only
 mechanism:  by value

GThis is a bitflag and all unused bits should be specified as zero. The Donly bit currently defined is VDE$V_CI_FLAG_SIGNAL: this bit causes >internal signals to generate text messages to SYS$OUTPUT: and CSYS$ERROR:. If clear---the default---no messages will be displayed.



Description

HVDE$ShowProjects displays the projects within the specified library and @stream. Each facility located results in a call to the callback Broutine. To perform the operation, the library and stream must be specified.

5As parameters specified to VDE callback routines are F"sticky", if a required parameter is not specified, it will 4be defaulted to the value used on a preceeding call.




Example

 #    

 
  
      

      
"      
           int RetStat;     int n; #    struct vdeil3 itmlst[MAX_IL3]; #    char *test_name, *test_remark; $    int test_length1, test_length2;     int NullArg = 0;          n = 0; %        test_name = "Other Project"; +        test_length1 = strlen (test_name); N itmlst[n].vde$w_itemlength  = (unsigned short) (unsigned char) test_length1; . itmlst[n].vde$w_itemcode  = VDE$_CI_PROJECT; 4 itmlst[n].vde$a_itempointer  = (char *) test_name; ) itmlst[n++].vde$a_itemreturnlength = 0;  7 test_remark = "this remark is for the Other Project"; & test_length2 = strlen (test_remark); N itmlst[n].vde$w_itemlength  = (unsigned short) (unsigned char) test_length2; - itmlst[n].vde$w_itemcode  = VDE$_CI_REMARK; 6 itmlst[n].vde$a_itempointer  = (char *) test_remark; ) itmlst[n++].vde$a_itemreturnlength = 0;  " itmlst[n].vde$w_itemlength  = 0;   itmlst[n].vde$w_itemcode  = 0; # itmlst[n].vde$a_itempointer  = 0; ) itmlst[n++].vde$a_itemreturnlength = 0;  M    retstat = VDE$ShowProjects( 0, itmlst, VDE$InterfaceTestShow, 0x0048B );  



+this section under construction...


L

VDE$ShowLibrary



AVDE$ShowLibrary displays information about the specified library.



Format

F

VDE$ShowLibrary context, itemlist, callback, callbackparam, flags 




Arguments



context


                
 VMS usage:
type:  longword integer (signed)
access:  read-write
 mechanism:  by reference

=This is the address of a longword used by VDE to reference a -context structure. This longword is optional.

GIf this argument is specified, the first call must pass in the address <of a longword zero. Once a VDE routine has been called, the @contents of the address referenced by this longword must not be modified by the caller.

itemlist


                
 VMS usage:
type:  itemlist
access:  read only
 mechanism:  by reference

9This is the address of an array of OpenVMS itemlist data structures.

 

" 
struct VDEIL3     { )    unsigned short int VDE$W_ITEMLENGTH; '    unsigned short int VDE$W_ITEMCODE;     char *VDE$A_ITEMPOINTER; '    short int *VDE$A_ITEMRETURNLENGTH;     }; 



FThe itemlist array must be terminated by a null-filled itemlist entry.

`See Table C-1 for a list of the itemlist codes.

callback


                
 VMS usage:
type:  function
access:  read only
 mechanism:  by reference

BThe callback routine is called to process individual entries in a Fdisplay operation. It is passed an itemlist containing information on Geach individual entry---the itemlist passed to the callback routine is Adistinct and seperate from the itemlist passed into the original Crequest, though it does contain a pointer to the caller's original itemlist.

>An example of the declaration of the callback routine follows:

 

" 
7int VDE$InterfaceTestShow( int, struct VDEIL3 *, int ) 



EThe first argument is not currently used. The second argument is the Faddress of the itemlist. The third argument is the callback parameter.

4The callback should return a successful status code.

callbackparam


                
 VMS usage:
type:  longword
access:  read only
 mechanism:  by value

BThe callback parameter is a longword value passed to the callback =routine. It is not interpreted by VDE. The interpretation of #the longword is left to the caller.

flags


                
 VMS usage:
type:  longword integer (signed)
access:  read-only
 mechanism:  by value

GThis is a bitflag and all unused bits should be specified as zero. The Donly bit currently defined is VDE$V_CI_FLAG_SIGNAL: this bit causes >internal signals to generate text messages to SYS$OUTPUT: and CSYS$ERROR:. If clear---the default---no messages will be displayed.



Description

BVDE$ShowLibrary displays information about the specified library. GInformation is returned via a call to the callback routine. To perform -the operation, the library must be specified.

5As parameters specified to VDE callback routines are F"sticky", if a required parameter is not specified, it will 4be defaulted to the value used on a preceeding call.




Example

 #    

 
  
      

      
"      
          int retstat;     int n;     struct VDEIL3 itmlst[20]; B    $DESCRIPTOR( library, "VDE$RESD2$:[VDE-MOTIF-DEMO.TSTLIB]" ); <    int VDE$InterfaceTestShow( int, struct VDEIL3 *, int );      n = 0; ?    itmlst[n].VDE$W_ItemCode                = VDE$_CI_LIBRARY; D    itmlst[n].VDE$W_ItemLength              = library.dsc$w_length; E    itmlst[n].VDE$A_ItemPointer             = library.dsc$a_pointer; 1    itmlst[n++].VDE$A_ItemReturnLength      = 0;  1    itmlst[n].VDE$W_ItemCode                = 0; 1    itmlst[n].VDE$W_ItemLength              = 0; 1    itmlst[n].VDE$A_ItemPointer             = 0; 1    itmlst[n++].VDE$A_ItemReturnLength      = 0;  M    retstat = VDE$ShowLibrary( 0, itmlst, VDE$InterfaceTestShow, 0x0048B  ); 



+this section under construction...


L

VDE$ShowModules



3VDE$ShowModules displays modules within a facility.



Format

F

VDE$ShowModules context, itemlist, callback, callbackparam, flags 




Arguments



context


                
 VMS usage:
type:  longword integer (signed)
access:  read-write
 mechanism:  by reference

=This is the address of a longword used by VDE to reference a -context structure. This longword is optional.

GIf this argument is specified, the first call must pass in the address <of a longword zero. Once a VDE routine has been called, the @contents of the address referenced by this longword must not be modified by the caller.

itemlist


                
 VMS usage:
type:  itemlist
access:  read only
 mechanism:  by reference

9This is the address of an array of OpenVMS itemlist data structures.

 

" 
struct VDEIL3     { )    unsigned short int VDE$W_ITEMLENGTH; '    unsigned short int VDE$W_ITEMCODE;     char *VDE$A_ITEMPOINTER; '    short int *VDE$A_ITEMRETURNLENGTH;     }; 



FThe itemlist array must be terminated by a null-filled itemlist entry.

`See Table C-1 for a list of the itemlist codes.

callback


                
 VMS usage:
type:  function
access:  read only
 mechanism:  by reference

BThe callback routine is called to process individual entries in a Fdisplay operation. It is passed an itemlist containing information on Geach individual entry---the itemlist passed to the callback routine is Adistinct and seperate from the itemlist passed into the original Crequest, though it does contain a pointer to the caller's original itemlist.

>An example of the declaration of the callback routine follows:

 

" 
7int VDE$InterfaceTestShow( int, struct VDEIL3 *, int ) 



EThe first argument is not currently used. The second argument is the Faddress of the itemlist. The third argument is the callback parameter.

4The callback should return a successful status code.

callbackparam


                
 VMS usage:
type:  longword
access:  read only
 mechanism:  by value

BThe callback parameter is a longword value passed to the callback =routine. It is not interpreted by VDE. The interpretation of #the longword is left to the caller.

flags


                
 VMS usage:
type:  longword integer (signed)
access:  read-only
 mechanism:  by value

GThis is a bitflag and all unused bits should be specified as zero. The Donly bit currently defined is VDE$V_CI_FLAG_SIGNAL: this bit causes >internal signals to generate text messages to SYS$OUTPUT: and CSYS$ERROR:. If clear---the default---no messages will be displayed.



Description

GVDE$ShowModules displays all modules within a specified facility. Each Emodule located results in a call to the callback routine. To perform ?the operation, the library, stream and facility module must be specified.

5As parameters specified to VDE callback routines are F"sticky", if a required parameter is not specified, it will 4be defaulted to the value used on a preceeding call.




Example

 #    

 
  
      

      
"      
          int retstat;     int n;     struct VDEIL3 itmlst[20]; B    $DESCRIPTOR( library, "VDE$RESD2$:[VDE-MOTIF-DEMO.TSTLIB]" ); #    $DESCRIPTOR( stream, "MAIN" ); %    $DESCRIPTOR( facility, "MAIN" ); <    int VDE$InterfaceTestShow( int, struct VDEIL3 *, int );      n = 0; ?    itmlst[n].VDE$W_ItemCode                = VDE$_CI_LIBRARY; D    itmlst[n].VDE$W_ItemLength              = library.dsc$w_length; E    itmlst[n].VDE$A_ItemPointer             = library.dsc$a_pointer; 1    itmlst[n++].VDE$A_ItemReturnLength      = 0;  >    itmlst[n].VDE$W_ItemCode                = VDE$_CI_STREAM; C    itmlst[n].VDE$W_ItemLength              = stream.dsc$w_length; D    itmlst[n].VDE$A_ItemPointer             = stream.dsc$a_pointer; 1    itmlst[n++].VDE$A_ItemReturnLength      = 0;  @    itmlst[n].VDE$W_ItemCode                = VDE$_CI_FACILITY; E    itmlst[n].VDE$W_ItemLength              = facility.dsc$w_length; F    itmlst[n].VDE$A_ItemPointer             = facility.dsc$a_pointer; 1    itmlst[n++].VDE$A_ItemReturnLength      = 0;  1    itmlst[n].VDE$W_ItemCode                = 0; 1    itmlst[n].VDE$W_ItemLength              = 0; 1    itmlst[n].VDE$A_ItemPointer             = 0; 1    itmlst[n++].VDE$A_ItemReturnLength      = 0;  L    retstat = VDE$ShowModules( 0, itmlst, VDE$InterfaceTestShow, 0x0048B ); 



+this section under construction...


L

VDE$ShowStreams



-VDE$ShowStreams fetches the specified module.



Format

F

VDE$ShowStreams context, itemlist, callback, callbackparam, flags 




Arguments



context


                
 VMS usage:
type:  longword integer (signed)
access:  read-write
 mechanism:  by reference

=This is the address of a longword used by VDE to reference a -context structure. This longword is optional.

GIf this argument is specified, the first call must pass in the address <of a longword zero. Once a VDE routine has been called, the @contents of the address referenced by this longword must not be modified by the caller.

itemlist


                
 VMS usage:
type:  itemlist
access:  read only
 mechanism:  by reference

9This is the address of an array of OpenVMS itemlist data structures.

 

" 
struct VDEIL3     { )    unsigned short int VDE$W_ITEMLENGTH; '    unsigned short int VDE$W_ITEMCODE;     char *VDE$A_ITEMPOINTER; '    short int *VDE$A_ITEMRETURNLENGTH;     }; 



FThe itemlist array must be terminated by a null-filled itemlist entry.

`See Table C-1 for a list of the itemlist codes.

callback


                
 VMS usage:
type:  function
access:  read only
 mechanism:  by reference

BThe callback routine is called to process individual entries in a Fdisplay operation. It is passed an itemlist containing information on Geach individual entry---the itemlist passed to the callback routine is Adistinct and seperate from the itemlist passed into the original Crequest, though it does contain a pointer to the caller's original itemlist.

>An example of the declaration of the callback routine follows:

 

" 
7int VDE$InterfaceTestShow( int, struct VDEIL3 *, int ) 



EThe first argument is not currently used. The second argument is the Faddress of the itemlist. The third argument is the callback parameter.

4The callback should return a successful status code.

callbackparam


                
 VMS usage:
type:  longword
access:  read only
 mechanism:  by value

BThe callback parameter is a longword value passed to the callback =routine. It is not interpreted by VDE. The interpretation of #the longword is left to the caller.

flags


                
 VMS usage:
type:  longword integer (signed)
access:  read-only
 mechanism:  by value

GThis is a bitflag and all unused bits should be specified as zero. The Donly bit currently defined is VDE$V_CI_FLAG_SIGNAL: this bit causes >internal signals to generate text messages to SYS$OUTPUT: and CSYS$ERROR:. If clear---the default---no messages will be displayed.



Description

GVDE$ShowStreams displays the streams present in the specified library. BEach stream located results in a call to the callback routine. To 5perform the operation, the library must be specified.

5As parameters specified to VDE callback routines are F"sticky", if a required parameter is not specified, it will 4be defaulted to the value used on a preceeding call.




Example

 #    

 
  
      

      
"      
          int retstat;     int n; (    struct VDEIL3 itmlst[MAX_ITEMLIST]; ,    $DESCRIPTOR( sys$login, "SYS$LOGIN:" ); B    $DESCRIPTOR( library, "VDE$RESD2$:[VDE-MOTIF-DEMO.TSTLIB]" ); #    $DESCRIPTOR( stream, "MAIN" ); %    $DESCRIPTOR( facility, "MAIN" ); /    $DESCRIPTOR( module, "[MAIN]BLISS1.B32" ); <    int VDE$InterfaceTestShow( int, struct VDEIL3 *, int );      n = 0; ?    itmlst[n].VDE$W_ItemCode                = VDE$_CI_LIBRARY; D    itmlst[n].VDE$W_ItemLength              = library.dsc$w_length; E    itmlst[n].VDE$A_ItemPointer             = library.dsc$a_pointer; 1    itmlst[n++].VDE$A_ItemReturnLength      = 0;  >    itmlst[n].VDE$W_ItemCode                = VDE$_CI_STREAM; C    itmlst[n].VDE$W_ItemLength              = stream.dsc$w_length; D    itmlst[n].VDE$A_ItemPointer             = stream.dsc$a_pointer; 1    itmlst[n++].VDE$A_ItemReturnLength      = 0;  @    itmlst[n].VDE$W_ItemCode                = VDE$_CI_FACILITY; E    itmlst[n].VDE$W_ItemLength              = facility.dsc$w_length; F    itmlst[n].VDE$A_ItemPointer             = facility.dsc$a_pointer; 1    itmlst[n++].VDE$A_ItemReturnLength      = 0;   1    itmlst[n].VDE$W_ItemCode                = 0; 1    itmlst[n].VDE$W_ItemLength              = 0; 1    itmlst[n].VDE$A_ItemPointer             = 0; 1    itmlst[n++].VDE$A_ItemReturnLength      = 0;  L    retstat = VDE$ShowStreams( 0, itmlst, VDE$InterfaceTestShow, 0x00246 ); 





 q
PreviousX Next[ Contents] Index