Problem Comment calls in GMPLWP ICR (4743)

Name

Value

NUMBER

4743

IA #

4743

DATE CREATED

2005/08/01

CUSTODIAL PACKAGE

PROBLEM LIST

USAGE

Controlled Subscription

TYPE

Routine

DBIC APPROVAL STATUS

APPROVED

ROUTINE

GMPLWP

NAME

Problem Comment calls in GMPLWP

GENERAL DESCRIPTION

This documents available calls to enter or return
Problem Comments.

STATUS

Active

DURATION

Till Otherwise Agreed

GMPLWP

COMPONENT/ENTRY POINT

COMPONENT DESCRIPTION

VARIABLES

GET(TEXT,IEN,WIDTH)

Returns the text of a problem comment, optionally
wrapped to a given width; unless otherwise specified, only plain text stripped
of all XHTML tags will be returned.

VARIABLES

TYPE

VARIABLES DESCRIPTION

TEXT

Both

Array name (closed root reference) in which to return
comment content as @TEXT@(n)=line of text

IEN

Input

IEN of Problem Comment (#125.5)

WIDTH

Input

Optional, maximum number of characters to return in
each line of text; 240 is used if not defined.  May also be set to "X" to
return the text with all XHTML tags as saved in the global, for use by GUI
clients.

EN(PROBLEM,AUTHOR,COMMENT)

Main entry point to save or update a problem comment.

VARIABLES

TYPE

VARIABLES DESCRIPTION

PROBLEM

Input

IEN of Problem (#9000011)

AUTHOR

Input

IEN of New Person (#200), the user responsible for
the content of the comment

COMMENT

Input

Closed array reference to the location of the comment
text, in standard FileMan word-processing format, to be accessed by
indirection

EDIT(PROBLEM,RETURN)

Interactive entry point to create or change comments

VARIABLES	TYPE	VARIABLES DESCRIPTION
PROBLEM	Input	IEN of Problem (#9000011)
RETURN	Both	Indicator, passed by reference, of whether new text was successfully entered (1) or if the action was aborted (^)
GMPROV	Used	IEN of New Person (#200), the user responsible for the content of the comment
GMPROB	Used	Text of problem description, optionally displayed in header of screen editor if defined

SUBSCRIBING PACKAGE