rem
rem $Header: L:\\\\model\\repman40\\api\\RCS\\rmtext.ops 1.2 1998/12/16 14:11:26 cvanes Exp $
rem
Rem  Copyright (c) 1993 by Oracle Corporation
Rem    NAME
Rem      rmotext.pkh - <one-line expansion of the name>
Rem    DESCRIPTION
Rem      <short description of component this file declares/defines>
Rem    RETURNS
Rem
Rem    NOTES
Rem      <other useful comments, qualifications, etc.>
Rem    MODIFIED   (MM/DD/YY)
rem     qttran     16/05/94 -  remove PRAGMA EXECPTION INITs
rem     qttran     14/02/94 -  Added ref. to readncl
rem     dcaruana   14/12/93 -  Change mode of ref on Close
Rem     qttran     10/09/93 -  add remtxtype procedure, clean a texttype
Rem     dcaruana   08/05/93 -  Created from rmm/rmstx.sql rm3/rm3btxo.pks

create or replace package  rmotext as

  invalid_handle                EXCEPTION;
    invalid_handle_fac  constant varchar2(3) := 'RME';
    invalid_handle_code constant number      := 1501;

  invalid_open_mode             EXCEPTION;
    invalid_mode_fac    constant varchar2(3) := 'RME';
    invalid_mode_code   constant number      := 1502;

  open_mode_disallows_operation EXCEPTION;
    operation_disallowed_fac  constant varchar2(3) := 'RME';
    operation_disallowed_code constant number      := 1503;

  destination_buffer_exceeded   EXCEPTION;
    buffer_exceeded_fac  constant varchar2(3) := 'RME';
    buffer_exceeded_code constant number      := 1504;

  invalid_text_type             EXCEPTION;
    invalid_text_type_fac  constant varchar2(3) := 'RME';
    invalid_text_type_code constant number      := 1505;

procedure close(
  ref in   rm.REFERENCE,
  stream_handle in  rm.STREAM);

procedure end_of_stream(
  ref in  rm.REFERENCE,
  stream_handle in  rm.STREAM,
  at_end  out rm.YESNO);

procedure open(
  ref in  rm.REFERENCE,
  txt_type  in     varchar2,
  element_type_for IN varchar2,
  stream_mode in  VARCHAR2,
  stream_handle out rm.STREAM);

procedure read_line(
  ref in  rm.REFERENCE,
  stream_handle in  rm.STREAM,
  buffer  in out  VARCHAR2,
  actualsize  out INTEGER);

procedure read_text(
  ref in  rm.REFERENCE,
  stream_handle in  rm.STREAM,
  textsize  in  INTEGER,
  buffer  in out  VARCHAR2,
  actualsize  out INTEGER);

procedure readall(
  ref in  rm.REFERENCE,
        txt_type IN     VARCHAR2,
  buffer  in out  VARCHAR2,
  buflen  in  INTEGER,
  bufret  out INTEGER);

procedure truncall(
  ref in  rm.REFERENCE,
  txt_type IN     VARCHAR2);

procedure write_newline(
  ref in  rm.REFERENCE,
  stream_handle in  rm.STREAM,
  actualsize  out INTEGER);

procedure write_text(
  ref in  rm.REFERENCE,
  stream_handle in  rm.STREAM,
  textsize  in  INTEGER,
  buffer  in  VARCHAR2,
  actualsize  out INTEGER);

procedure writeall(
  ref in  rm.REFERENCE,
  txt_type IN     VARCHAR2,
  element_type_for IN varchar2,
  buffer  in  VARCHAR2,
  buflen  in  INTEGER,
  bufwrt  out INTEGER);

procedure remtxtype(txt_type IN     VARCHAR2);

procedure openl(
  ref in  rm.REFERENCE,
  txt_type  in     varchar2,
  element_type_for IN varchar2,
  stream_mode in  VARCHAR2,
  stream_handle out rm.STREAM,
        txt_len  out INTEGER);

procedure readncl(
  ref in  rm.REFERENCE,
  stream_handle in rm.STREAM,
  buflen  in  INTEGER,
  buffer  in out  VARCHAR2,
  bufret  out INTEGER);

end rmotext;
/