HELPLIB.HLB  —  RTL Routines, OTS$
of the source string pointed to by source-string-address is greater than the length of destination-string. Otherwise, the value is 0 (zero).

44.3  –  Arguments

 word-int-source-length-val

    OpenVMS usage:word_unsigned
    type:         word (unsigned)
    access:       read only
    mechanism:    by value

    Length of the source string. The word-int-source-length-val
    argument is an unsigned word integer containing the length of
    the source string.

 source-string-address

    OpenVMS usage:char_string
    type:         character string
    access:       read only
    mechanism:    by reference

    Source string. The source-string-address argument is the address
    of the source string.

 destination-string

    OpenVMS usage:char_string
    type:         character string
    access:       write only
    mechanism:    by descriptor

    Destination string. The destination-string argument is the
    address of a descriptor pointing to the destination string.
    OTS$SCOPY_R_DX determines the appropriate action based on the
    descriptor's CLASS field. The descriptor's LENGTH field alone or
    both the POINTER and LENGTH fields can be modified if the string
    is dynamic. For varying strings, the string's current length
    (CURLEN) is rewritten.

45  –  OTS$SFREE1_DD

    The Strings, Free One Dynamic routine returns one dynamic string
    area to free storage.

    Format

      OTS$SFREE1_DD  dynamic-descriptor

45.1  –  Corresponding JSB Entry Point

      OTS$SFREE1_DD6

45.2  –  Returns

    None.

45.3  –  Argument

 dynamic-descriptor

    OpenVMS usage:quadword_unsigned
    type:         quadword (unsigned)
    access:       modify
    mechanism:    by reference

    Dynamic string descriptor. The dynamic-descriptor argument is
    the address of the dynamic string descriptor. The descriptor is
    assumed to be dynamic and its class field is not checked.

46  –  OTS$SFREEN_DD

    The Free n Dynamic Strings routine takes as input a vector of one
    or more dynamic string areas and returns them to free storage.

    Format

      OTS$SFREEN_DD  descriptor-count-value ,first-descriptor

46.1  –  Corresponding JSB Entry Point

      OTS$SFREEN_DD6

46.2  –  Returns

    None.

46.3  –  Arguments

 descriptor-count-value

    OpenVMS usage:longword_unsigned
    type:         longword (unsigned)
    access:       read only
    mechanism:    by value

    Number of adjacent descriptors to be flagged as having no
    allocated area (the descriptor's POINTER and LENGTH fields
    contain 0) and to have their allocated areas returned to free
    storage by OTS$SFREEN_DD. The descriptor-count-value argument is
    an unsigned longword containing this number.

 first-descriptor

    OpenVMS usage:quadword_unsigned
    type:         quadword (unsigned)
    access:       modify
    mechanism:    by reference

    First string descriptor of an array of string descriptors. The
    first-descriptor argument is the address of the first string
    descriptor. The descriptors are assumed to be dynamic, and their
    class fields are not checked.

47  –  OTS$SGET1_DD

    The Get One Dynamic String routine allocates a specified
    number of bytes of dynamic virtual memory to a specified string
    descriptor.

    Format

      OTS$SGET1_DD  word-integer-length-value ,dynamic-descriptor

47.1  –  Corresponding JSB Entry Point

      OTS$SGET1_DD_R6

47.2  –  Returns

    None.

47.3  –  Arguments

 word-integer-length-value

    OpenVMS usage:word_unsigned
    type:         word (unsigned)
    access:       read only
    mechanism:    by value

    Number of bytes to be allocated. The word-integer-length-value
    argument contains the number of bytes. The amount of storage
    allocated is automatically rounded up. If the number of bytes is
    zero, a small number of bytes is allocated.

 dynamic-descriptor

    OpenVMS usage:quadword_unsigned
    type:         quadword (unsigned)
    access:       modify
    mechanism:    by reference

    Dynamic string descriptor to which the area is to be allocated.
    The dyn-str argument is the address of the dynamic string
    descriptor. The CLASS field is not checked but it is set to
    dynamic (CLASS = 2). The LENGTH field is set to word-integer-
    length-value and the POINTER field is set to the string area
    allocated (first byte beyond the header).
Close Help