vs
Class ByRef

java.lang.Object
  extended byvs.VMSparam
      extended byvs.ByRef

public class ByRef
extends VMSparam

Used to pass a parameter by reference. This is the equivalend to similar constructs in other languages, such as:

PL/I declare efn fixed binary(31);

sts$value = lib$get_ef(reference(efn));

BASIC declare long efn

call lib$get_ef(efn by ref)

C int efn;

lib$get_ef(&efn);

The following Java code performs the same operation:

 int efn;

 lib.lib$get_ef(new VMSparam[] {
                    new ByRef(efn)
                });
 

See Also:
ByDesc, ByVal

Constructor Summary
ByRef(byte b)
          Pass a byte by reference.
ByRef(java.lang.Byte b)
          Pass a Byte object by reference.
ByRef(byte[] b)
          Pass a byte array by reference.
ByRef(Cmem b)
          Pass a Cmem object by reference.
ByRef(int i)
          Pass an int by reference.
ByRef(int[] b)
          Pass an array of int by reference.
ByRef(java.lang.Integer b)
          Pass an Integer object by reference.
ByRef(long l)
          Pass a long by reference.
ByRef(java.lang.Long b)
          Pass a Long object by reference.
ByRef(long[] b)
          Pass an array of long by reference.
ByRef(short s)
          Pass a short by reference.
ByRef(java.lang.Short b)
          Pass a Short object by reference.
ByRef(short[] b)
          Pass an array of short by reference.
ByRef(java.lang.String s)
          Pass a String object by reference.
ByRef(VmsStruct s)
          Pass a VmsStruct by reference.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

ByRef

public ByRef(VmsStruct s)
Pass a VmsStruct by reference.

This is simply a convenience method that is equivalent to the following Java code snippet.

 new ByRef(s.getTarget())
 

Parameters:
s - VmsStruct to pass by reference.

ByRef

public ByRef(byte[] b)
Pass a byte array by reference.

Parameters:
b - byte array to be passed by reference.

ByRef

public ByRef(int[] b)
Pass an array of int by reference.

Parameters:
b - int array to be passed by reference.

ByRef

public ByRef(short[] b)
Pass an array of short by reference.

Parameters:
b - short array to be passed by reference.

ByRef

public ByRef(long[] b)
Pass an array of long by reference.

Parameters:
b - long array to be passed by reference.

ByRef

public ByRef(java.lang.Long b)
Pass a Long object by reference.

Parameters:
b - Long object to be passed by reference.

ByRef

public ByRef(java.lang.Integer b)
Pass an Integer object by reference.

Parameters:
b - Integer object to be passed by reference.

ByRef

public ByRef(java.lang.Short b)
Pass a Short object by reference.

Parameters:
b - Short object to be passed by reference.

ByRef

public ByRef(java.lang.Byte b)
Pass a Byte object by reference.

Parameters:
b - Byte object to be passed by reference.

ByRef

public ByRef(Cmem b)
Pass a Cmem object by reference.

Parameters:
b - Cmem object to be passed by reference.

ByRef

public ByRef(java.lang.String s)
Pass a String object by reference.

Note: This is a convenience constructor. Using this constructor prevents any results being returned in s.

Parameters:
s - String object to be passed by reference.

ByRef

public ByRef(byte b)
Pass a byte by reference.

Note: This is a convenience constructor. Using this constructor prevents any results being returned in b.

Parameters:
b - byte to be passed by reference.

ByRef

public ByRef(int i)
Pass an int by reference.

Note: This is a convenience constructor. Using this constructor prevents any results being returned in i.

Parameters:
i - int to be passed by reference.

ByRef

public ByRef(long l)
Pass a long by reference.

Note: This is a convenience constructor. Using this constructor prevents any results being returned in l.

Parameters:
l - long to be passed by reference.

ByRef

public ByRef(short s)
Pass a short by reference.

Note: This is a convenience constructor. Using this constructor prevents any results being returned in s.

Parameters:
s - short to be passed by reference.