BBjConfig::requireAllSendMsgResponses

Description

This method controls whether the Interpreter waits for a response from certain SENDMSG functions before proceeding with the next program statement.

Syntax

Return Value

Method

void

requireAllSendMsgResponses(boolean require)

Parameters

Variable

Description

require

Specifies whether SENDMSG responses are required:

0 = Not required (False)

1 = Required (True)

Return Value

None.

Remarks

All SENDMSG functions return a string value. However, in many cases that return value is typically ignored.

In normal operation, the Interpreter executes SENDMSG() by sending a message to the client. The client executes code and generates a response, which is then sent back to the server. The Interpreter cannot process the next program statement until this response is received. Depending on the speed of the connection between the client and server, the time required for communication can be much greater than the time required for the actual command execution on the client side.

If requireAllSendMsgResponses is set to TRUE, then the Interpreter will wait for a response to each SENDMSG before executing the next program statement. If requireAllSendMsgResponses is set to FALSE, then in selected cases the Interpreter will not wait for a response but instead will immediately return the standard response that corresponds to successful completion.

The following table lists the affected messages and standard responses.

SENDMSG(sysgui,GRID,function,intParam,strParam,context)

Function

Return Value

21

$01$

22

$01$

23

$01$

24

$01$

25

$01$

26

$01$

27

$01$

28

$01$

29

$01$

30

$01$

31

$01$

32

$01$

33

$01$

35

$01$

36

$01$

49

$$

50

$01$

52

$$

53

$$

54

$01$

55

$$

56

$$

57

$$

58

$00$ if intParam was 0, otherwise $01$

59

$$

61

$000000$ (assume pen color is black)

62

BIN(intParam,4)

63

$$

64

$$

65

$$

66

BIN(intParam,4)

67

BIN(intParam,4)

68

BIN(intParam,4)

69

$00$ if intParam was 0, otherwise $01$

71

$$

72

$00$ if intParam was 0, otherwise $01$

74

$$

75

$01$

76

$$

77

$00$ if intParam was 0, otherwise $01$

78

$01$

79

$01$

80

$01$

82

$$

83

$$

84

$$

86

$01$

100

$01$

101

$01$

102

$01$

103

$01$

104

$01$

105

$01$

106

$01$

107

$01$

108

$01$

109

$01$

110

$01$

111

$01$

112

$$

SENDMSG(sysgui,INPUTE,function,intParam,strParam,context)

21

$01$

23

$01$

25

$01$

27

$01$

29

$01$

30

$01$

31

$01$

32

$01$

33

$01$

34

$01$

36

$$

37

$01$

38

$01$

SENDMSG(sysgui,INPUTN,function,intParam,strParam,context)

21

$01$

23

$01$

27

$01$

28

$01$

29

$01$

30

$01$

31

$01$

32

$01$

33

$01$

38

$01$

SENDMSG(sysgui,STATBAR,function,intParam,strParam,context)

20

$01$

25

$$

27

$01$

SENDMSG(sysgui,TABCTRL,function,intParam,strParam,context)

23

$00000000$

24

$$

25

$01$

26

$01$

34

BIN(intParam,2)

35

$01$

36

$01$

37

$01$

39

$$

SENDMSG(sysgui,ID,function,intParam,strParam,context)

23

$00$ if intParam was 0, otherwise $01$

 

Important Note: Setting RequireAllSendMsgResponses to false can provide a significant improvement in the responsiveness of a client/server program that uses SENDMSG(). However, some error and return information is lost. This should only be done if the application will function correctly with the standard return values listed above, and if the application does not depend on trapping errors from SENDMSG() functions.

Example

BBjApi().getConfig().requireAllSendMsgResponses(BBjApi().FALSE)

See Also

BBjAPI

BBjConfig

See the BBj Object Diagram for an illustration of the relationship between BBj Objects.