Kernel Toolkit 7.3 APIs Banner
Office of Information and Technology (OIT) Banner
[skip navigation]

GETENT^XPAREDIT(): Prompt for Entity Based on Parameter

Reference Type: Supported, Category: Toolkit—Parameter Tools, ICR#: 2336

Description

The GETENT^XPAREDIT API interactively prompts for an entity, based on the definition of a parameter.

Format

  GETENT^XPAREDIT(.entity,parameter[,.onlyone?])

Input Parameters

.entity:

(required) Returns the selected entity in VARIABLE POINTER format.
parameter:

(required) Identifies the parameter that should be edited. Parameter should contain two pieces:

     IEN^DisplayNameOfParameter

Output Parameter

.onlyone?:

(optional) Returns 1 if there is only one possible entity for the value. For example:

  • 1—If the parameter can only be set for the system, onlyone?.

  • 0—If the parameter could be set for any location, onlyone?.