Name
prt_api_intproc_region
Purpose
Receive updates only from specific regions.
Description
This function provides a mechanism for a process to request that only specific region data is required. A flag is passed to specify if the region should be added, replaced, or deleted. The calling routine receives back a status indicating the success or failure of the request.
Syntax
int prt_api_intproc_region (region_id, action_code, retstat)
char *region_id;
COR_U4 action_code;
COR_STATUS *retstat;
Data Structures
None
Arguments
|
Argument |
Description |
|
|
Input |
|
|
|
region_id |
Region that this call applies to |
|
|
action_code |
Code to specify what action needs to occur. Valid values are: |
|
|
|
PRT_FILTER_ADD |
Add this region_id to filter list. |
|
|
PRT_FILTER_REPLACE |
Replace existing filter region_id with this one, if one exists. Otherwise add region_id |
|
|
PRT_FILTER_DELETE |
Delete this region_id from filter list. |
|
Output |
|
|
|
*retstat |
Pointer to COR_STATUS structure |
|
Return Value
Either COR_SUCCESS or COR_FAILURE.
If the function returns COR_FAILURE additional error information can be found in the COR_STATUS structure.
Error Codes
|
IPC_ERR_PARTDEAD |
Partner Dead (Warning) |
|
PRTI_UNKNOWN_INIT_SRC |
MF_INIT segment received from unknown service (Warning). |
|
PRTI_UNEXPECTED_SEG |
Unexpected segment type (Warning) |
|
PRTI_BAD_MSG |
Error in segment (Failure) |
|
PRTI_READ_PORT_ERR |
Error in ipc_read_port (Failure) |
|
PRTI_EF_CHECK_ERR |
Error checking event flag (Failure) |
|
|
Application subroutines. |
