VDE
VDE
Reference Manual
Previous Contents Index

VDE$ShowFacilities

VDE$ShowFacilities displays facilities within the specified stream.

Format

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.

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$ShowFacilities displays the facilities within the specified library and stream. Each facility located results in a call to the 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( 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; 
    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$ShowFacilities( 0, itmlst, VDE$InterfaceTestShow, 0x0048B );

this section under construction...

VDE$ShowProjects

VDE$ShowProjects displays projects within the specified stream.

Format

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.

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$ShowProjects displays the projects within the specified library and stream. Each facility located results in a call to the 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[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); 
 itmlst[n].vde$w_itemlength  = (unsigned short) (unsigned char) test_length1; 
 itmlst[n].vde$w_itemcode  = VDE$_CI_PROJECT; 
 itmlst[n].vde$a_itempointer  = (char *) test_name; 
 itmlst[n++].vde$a_itemreturnlength = 0; 
 
 test_remark = "this remark is for the Other Project"; 
 test_length2 = strlen (test_remark); 
 itmlst[n].vde$w_itemlength  = (unsigned short) (unsigned char) test_length2; 
 itmlst[n].vde$w_itemcode  = VDE$_CI_REMARK; 
 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; 
 
    retstat = VDE$ShowProjects( 0, itmlst, VDE$InterfaceTestShow, 0x0048B );

this section under construction...

VDE$ShowLibrary

VDE$ShowLibrary displays information about the specified library.

Format

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.

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$ShowLibrary displays information about the specified library. Information is returned via a call to the callback routine. To perform the operation, 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]" ); 
    int VDE$InterfaceTestShow( int, struct VDEIL3 *, int ); 
 
    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$ShowLibrary( 0, itmlst, VDE$InterfaceTestShow, 0x0048B  );

this section under construction...

VDE$ShowModules

VDE$ShowModules displays modules within a facility.

Format

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.

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$ShowModules displays all modules within a specified facility. Each module located results in a call to the callback routine. To perform the operation, the library, stream and facility 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


 
 





  

    
      

      
 
  
 
  
    int retstat; 
    int n; 
    struct VDEIL3 itmlst[20]; 
    $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; 
    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$ShowModules( 0, itmlst, VDE$InterfaceTestShow, 0x0048B );

this section under construction...

VDE$ShowStreams

VDE$ShowStreams fetches the specified module.

Format

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.

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$ShowStreams displays the streams present in the specified library. Each stream located results in a call to the callback routine. To perform the operation, 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[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" ); 
    int VDE$InterfaceTestShow( int, struct VDEIL3 *, int ); 
 
    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$ShowStreams( 0, itmlst, VDE$InterfaceTestShow, 0x00246 );

Previous Next Contents Index