RPC Broker APIs: $$RTRNFMT^XWBLIB

$$RTRNFMT^XWBLIB(): Change RPC Return Type

Reference Type: Supported, Category: RPC Broker, ICR#: 2238

Description

Use the $$RTRNFMT^XWBLIB extrinsic function in the M code called by an RPC to change the return value type that the RPC returns on-the-fly.

Format

  $$RTRNFMT^XWBLIB(type,wrap)

Input Parameters

type:

(required) Set this to the RETURN VALUE TYPE to which you want to change the RPC’s setting. Set it to one of the following numeric or free text values:

Numeric	Free Text
1	SINGLE VALUE
2	ARRAY
3	WORD PROCESSING
4	GLOBAL ARRAY
5	GLOBAL INSTANCE

wrap:

(required) Set value to:

1—Set RPC’s WORD WRAP ON setting to True.
0—Set RPC’s WORD WRAP ON setting to False.

Output

return value:

Returns:

0—If the return value type could not be changed.
numeric code—Representing the return value type to which the RPC is changed.

Example

I ‘$$RTRNFMT^XWBLIB(“ARRAY”,1) D .; branch to code if cannot change RPC type