VDE
VDE
Reference Manual
Previous Contents Index

VDE$FetchModule

VDE$FetchModule fetches the specified module.

Format

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.

If 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

This 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; 
    };

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

callback


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

The callback routine is called to process individual entries in a display operation. It is passed an itemlist containing information on each individual entry---the itemlist passed to the callback routine is distinct and seperate from the itemlist passed into the original request, though it does contain a pointer to the caller's original itemlist.

An example of the declaration of the callback routine follows: 


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

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

The callback should return a successful status code.

callbackparam


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

The 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

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

Description

VDE$FetchModule performs a fetch of the specified module. To perform a fetch, the library, stream, facility and module must be specified.

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

Example


 
 





  

    
      

      
 
  
 
  
    struct VDEIL3 itmlst[MAX_ITEMLIST]; 
    $DESCRIPTOR( sys$login, "SYS$LOGIN:" ); 
    $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; 
    itmlst[n].VDE$W_ItemLength              = library.dsc$w_length; 
    itmlst[n].VDE$A_ItemPointer             = library.dsc$a_pointer; 
    itmlst[n++].VDE$A_ItemReturnLength      = 0; 
 
    itmlst[n].VDE$W_ItemCode                = VDE$_CI_STREAM; 
    itmlst[n].VDE$W_ItemLength              = stream.dsc$w_length; 
    itmlst[n].VDE$A_ItemPointer             = stream.dsc$a_pointer; 
    itmlst[n++].VDE$A_ItemReturnLength      = 0; 
 
    itmlst[n].VDE$W_ItemCode                = VDE$_CI_FACILITY; 
    itmlst[n].VDE$W_ItemLength              = facility.dsc$w_length; 
    itmlst[n].VDE$A_ItemPointer             = facility.dsc$a_pointer; 
    itmlst[n++].VDE$A_ItemReturnLength      = 0; 
 
    itmlst[n].VDE$W_ItemCode                = VDE$_CI_MODULE; 
    itmlst[n].VDE$W_ItemLength              = module.dsc$w_length; 
    itmlst[n].VDE$A_ItemPointer             = module.dsc$a_pointer; 
    itmlst[n++].VDE$A_ItemReturnLength      = 0; 
 
    itmlst[n].VDE$W_ItemCode                = VDE$_CI_OUTPUT; 
    itmlst[n].VDE$W_ItemLength              = sys$login.dsc$w_length; 
    itmlst[n].VDE$A_ItemPointer             = sys$login.dsc$a_pointer; 
    itmlst[n++].VDE$A_ItemReturnLength      = 0; 
 
    itmlst[n].VDE$W_ItemCode                = 0; 
    itmlst[n].VDE$W_ItemLength              = 0; 
    itmlst[n].VDE$A_ItemPointer             = 0; 
    itmlst[n++].VDE$A_ItemReturnLength      = 0; 
 
    retstat = VDE$FetchModule( 0, itmlst, 0, 0 );

this section under construction...

VDE$ReplaceModule

VDE$ReplaceModule replaces the specified module.

Format

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.

If 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

This 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; 
    };

The 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

The callback routine is called to process individual entries in a display operation. It is passed an itemlist containing information on each individual entry---the itemlist passed to the callback routine is distinct and seperate from the itemlist passed into the original request, though it does contain a pointer to the caller's original itemlist.

An example of the declaration of the callback routine follows: 


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

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

The callback should return a successful status code.

callbackparam


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

The 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

This is a bitflag and all unused bits should be specified as zero. The only bit currently defined is VDE$V_CI_FLAG_SIGNAL: this bit causes internal signals to generate text messages to SYS$OUTPUT: and SYS$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 specified. In addition, the replacement "cause" must be specified for certain VDE libraries.

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

Example


 
 





  

    
      

      
 
  
 
  
 
----- under construction -----

this section under construction...

VDE$SetFacility

VDE$SetFacility sets the specified facility as the default.

Format

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.

If 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

This 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; 
    };

The 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

The callback routine is called to process individual entries in a display operation. It is passed an itemlist containing information on each individual entry---the itemlist passed to the callback routine is distinct and seperate from the itemlist passed into the original request, though it does contain a pointer to the caller's original itemlist.

An example of the declaration of the callback routine follows: 


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

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

The callback should return a successful status code.

callbackparam


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

The 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

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

Description

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

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

Example


 
 





  

    
      

      
 
  
 
  
    int retstat; 
    int n; 
    struct VDEIL3 itmlst[20]; 
    $DESCRIPTOR( sys$login, "SYS$LOGIN:" ); 
    $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; 
    itmlst[n].VDE$W_ItemLength              = library.dsc$w_length; 
    itmlst[n].VDE$A_ItemPointer             = library.dsc$a_pointer; 
    itmlst[n++].VDE$A_ItemReturnLength      = 0; 
 
    itmlst[n].VDE$W_ItemCode                = VDE$_CI_STREAM; 
    itmlst[n].VDE$W_ItemLength              = stream.dsc$w_length; 
    itmlst[n].VDE$A_ItemPointer             = stream.dsc$a_pointer; 
    itmlst[n++].VDE$A_ItemReturnLength      = 0; 
 
    itmlst[n].VDE$W_ItemCode                = VDE$_CI_FACILITY; 
    itmlst[n].VDE$W_ItemLength              = facility.dsc$w_length; 
    itmlst[n].VDE$A_ItemPointer             = facility.dsc$a_pointer; 
    itmlst[n++].VDE$A_ItemReturnLength      = 0; 
 
    itmlst[n].VDE$W_ItemCode                = 0; 
    itmlst[n].VDE$W_ItemLength              = 0; 
    itmlst[n].VDE$A_ItemPointer             = 0; 
    itmlst[n++].VDE$A_ItemReturnLength      = 0; 
 
    retstat = VDE$SetFacility( 0, itmlst, 0, 0 );

this section under construction...

VDE$SetLibrary

VDE$SetLibrary accesses the specified library.

Format

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.

If 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

This 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; 
    };

The 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

The callback routine is called to process individual entries in a display operation. It is passed an itemlist containing information on each individual entry---the itemlist passed to the callback routine is distinct and seperate from the itemlist passed into the original request, though it does contain a pointer to the caller's original itemlist.

An example of the declaration of the callback routine follows: 


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

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

The callback should return a successful status code.

callbackparam


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

The 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

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

Description

VDE$SetLibrary accesses the specified library. This command can be explicitly called, or it can be implicitly called from within one of the other routines. To perform the access, the library must be specified.

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

Example


 
 





  

    
      

      
 
  
 
  
    int retstat; 
    int n; 
    struct VDEIL3 itmlst[20]; 
    $DESCRIPTOR( library, "VDE$RESD2$:[VDE-MOTIF-DEMO.TSTLIB]" ); 
 
    n = 0; 
    itmlst[n].VDE$W_ItemCode                = VDE$_CI_LIBRARY; 
    itmlst[n].VDE$W_ItemLength              = library.dsc$w_length; 
    itmlst[n].VDE$A_ItemPointer             = library.dsc$a_pointer; 
    itmlst[n++].VDE$A_ItemReturnLength      = 0; 
 
    itmlst[n].VDE$W_ItemCode                = 0; 
    itmlst[n].VDE$W_ItemLength              = 0; 
    itmlst[n].VDE$A_ItemPointer             = 0; 
    itmlst[n++].VDE$A_ItemReturnLength      = 0; 
 
    retstat = VDE$SetLibrary( 0, itmlst, 0, 0 );

this section under construction...

VDE$SetStream

VDE$SetStream sets the default stream.

Format

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.

If 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

This 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; 
    };

The 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

The callback routine is called to process individual entries in a display operation. It is passed an itemlist containing information on each individual entry---the itemlist passed to the callback routine is distinct and seperate from the itemlist passed into the original request, though it does contain a pointer to the caller's original itemlist.

An example of the declaration of the callback routine follows: 


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

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

The callback should return a successful status code.

callbackparam


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

The 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

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

Description

VDE$SetStream sets the default to the specified stream. This routine can be called explicitly, or implicitly from within another callback routine. To perform the operation, the library and stream must be specified.

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

Example


 
 





  

    
      

      
 
  
 
  
    int retstat; 
    int n; 
    struct VDEIL3 itmlst[20]; 
    $DESCRIPTOR( sys$login, "SYS$LOGIN:" ); 
    $DESCRIPTOR( library, "VDE$RESD2$:[VDE-MOTIF-DEMO.TSTLIB]" ); 
    $DESCRIPTOR( stream, "MAIN" ); 
 
    n = 0; 
    itmlst[n].VDE$W_ItemCode                = VDE$_CI_LIBRARY; 
    itmlst[n].VDE$W_ItemLength              = library.dsc$w_length; 
    itmlst[n].VDE$A_ItemPointer             = library.dsc$a_pointer; 
    itmlst[n++].VDE$A_ItemReturnLength      = 0; 
 
    itmlst[n].VDE$W_ItemCode                = VDE$_CI_STREAM; 
    itmlst[n].VDE$W_ItemLength              = stream.dsc$w_length; 
    itmlst[n].VDE$A_ItemPointer             = stream.dsc$a_pointer; 
    itmlst[n++].VDE$A_ItemReturnLength      = 0; 
 
    itmlst[n].VDE$W_ItemCode                = 0; 
    itmlst[n].VDE$W_ItemLength              = 0; 
    itmlst[n].VDE$A_ItemPointer             = 0; 
    itmlst[n++].VDE$A_ItemReturnLength      = 0; 
 
    retstat = VDE$SetStream( 0, itmlst, 0, 0 );

this section under construction...

Previous Next Contents Index