Name

pinit_string3 − Sets the string device to application-specific values. 

Operating States: PHOP, WSOP, ∗, ∗
PHIGS standard function

Syntax

void pinit_string3 (
  Pint                  wsid,         /∗ (I) Workstation identifier ∗/
  Pint                  dev_num,      /∗ (I) String device number ∗/
  const char           ∗init,         /∗ (I) Initial string ∗/
  Pint                  pet,          /∗ (I) Prompt and echo type ∗/
  const Plimit3        ∗echo_vol,     /∗ (I) Echo area, in device
                                             coordinates ∗/
  const Pstring_data3  ∗record        /∗ (I) Data record ∗/
)

Data Structures

typedef struct {
    Pfloat    x_min;    /∗ x minimum ∗/
    Pfloat    x_max;    /∗ x maximum ∗/
    Pfloat    y_min;    /∗ y minimum ∗/
    Pfloat    y_max;    /∗ y maximum ∗/
    Pfloat    z_min;    /∗ z minimum ∗/
    Pfloat    z_max;    /∗ z maximum ∗/
} Plimit3;
typedef struct { /∗ string data record ∗/
    Pint    in_buf_size;     /∗ input buffer size ∗/
    Pint    init_pos;        /∗ initial editing position ∗/
    union Pstring3_pets {
        struct Pstring3_pet_r1 {
            char     ∗title_string;   /∗ title string for the device ∗/
        } pet_r1;
    } pets;
} Pstring_data3;

Description

pinit_string3 sets the string device to application-specific values.  This function accepts the initial (default) string and echo volume.  The echo volume is a 6-component list of x-, y-, and z-coordinates, in device coordinates.  The order of the list components is XMIN < XMAX, YMIN < YMAX, ZMIN < ZMAX. 

When an application calls pinit_string3, the workstation surface cannot contain the string device’s prompt. To remove an existing prompt from the surface, call the pset_string_mode function and place the device in request mode. 

The size and contents of the data record depend on the prompt and echo type you specify.  If the size or contents of the data record does not match the requirements of your chosen prompt and echo type, Digital PHIGS generates an error. 

See String-Class PET for information on string-class prompt and echo types. 

See Also

pget_string
pinit_string
pinq_def_string_data3
pinq_string_st3
preq_string
psample_string
pset_string_mode