TipcMsgGetNamedMsgArray

Name

TipcMsgGetNamedMsgArray — get a field containing an array of MSG values from a message, using a name

Synopsis

T_BOOL TipcMsgGetNamedMsgArray(msg, name, value_return, size_return) 
T_IPC_MSG msg; 
T_STR name; 
T_IPC_MSG **value_return; 
T_INT4 *size_return;

Arguments

msg — message to get field from

name — name of the field

value_return — return pointer to value of the field

size_return — pointer to size of the field, in bytes

Return Values

TRUE if the get was successful, FALSE otherwise.

Diagnostics

If TipcMsgGetNamedMsgArray fails, it returns FALSE and sets the global SmartSockets error number to:

T_ERR_NULL_PTR — msg was null or name was null

T_ERR_MSG_INVALID — msg was not a valid message

Description

TipcMsgGetNamedMsgArray gets the field specified by the name. The returned pointer should be considered read-only. The function fails if:

No field by this name exists.

The field associated with this name is not a MSG_ARRAY field.

The field associated with this name is unknown. See the TIBCO SmartSockets User’s Guide for more information on unknown field values.

Caution

If TipcMsgGetNamedMsgArray returns FALSE, it does not store a value in value_return.

Do not modify the value in value_return. It points directly into an internal data structure.

Examples

This example gets a MSG_ARRAY field from an existing message:

T_IPC_MSG msg; 
T_BOOL status; 
T_IPC_MSG *value; 
T_INT4 size; 
status = TipcMsgGetNamedMsgArray(msg, "foo", &value, &size); 
if (status == FALSE) { 
  return;  /* error */ 
}