RVDE7

VDE
VDE
Reference Manual


 q
Previous[ Contents] Index


L

VDE$FetchModule



-VDE$FetchModule fetches the specified module.



Format

F

VDE$FetchModule 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.

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$FetchModule performs a fetch of the specified module. To perform a Bfetch, the library, stream, facility and 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

 #    

 
  
      

      
"      
      (    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" );     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;  >    itmlst[n].VDE$W_ItemCode                = VDE$_CI_MODULE; C    itmlst[n].VDE$W_ItemLength              = module.dsc$w_length; D    itmlst[n].VDE$A_ItemPointer             = module.dsc$a_pointer; 1    itmlst[n++].VDE$A_ItemReturnLength      = 0;  >    itmlst[n].VDE$W_ItemCode                = VDE$_CI_OUTPUT; F    itmlst[n].VDE$W_ItemLength              = sys$login.dsc$w_length; G    itmlst[n].VDE$A_ItemPointer             = sys$login.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;  2    retstat = VDE$FetchModule( 0, itmlst, 0, 0 ); 



+this section under construction...


P

VDE$ReplaceModule



0VDE$ReplaceModule replaces the specified module.



Format

H

VDE$ReplaceModule 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

>VDE$ReplaceModule replaces the specified module. To perform a >replacement, the library, stream, facility and module must be Bspecified. In addition, the replacement "cause" must be $specified for certain VDE libraries.

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

 #    

 
  
      

      
"      
       ----- under construction -----  



+this section under construction...


L

VDE$SetFacility



;VDE$SetFacility sets the specified facility as the default.



Format

F

VDE$SetFacility 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

DVDE$SetFacility sets the specified facility as the default. Various Gcommands and callbacks require this. Requires the specification of the "the library, stream, and facility.

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]; ,    $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" );      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;  2    retstat = VDE$SetFacility( 0, itmlst, 0, 0 ); 



+this section under construction...


J

VDE$SetLibrary



.VDE$SetLibrary accesses the specified library.



Format

E

VDE$SetLibrary 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

CVDE$SetLibrary accesses the specified library. This command can be Eexplicitly called, or it can be implicitly called from within one of ?the other routines. To perform the access, 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]" );      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;  1    retstat = VDE$SetLibrary( 0, itmlst, 0, 0 ); 



+this section under construction...


H

VDE$SetStream



&VDE$SetStream sets the default stream.



Format

D

VDE$SetStream 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

EVDE$SetStream sets the default to the specified stream. This routine Ecan be called explicitly, or implicitly from within another 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]; ,    $DESCRIPTOR( sys$login, "SYS$LOGIN:" ); B    $DESCRIPTOR( library, "VDE$RESD2$:[VDE-MOTIF-DEMO.TSTLIB]" ); #    $DESCRIPTOR( stream, "MAIN" );      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;  0    retstat = VDE$SetStream( 0, itmlst, 0, 0 ); 



+this section under construction...





 q
PreviousX Next[ Contents] Index