|
Broadcast List Functions |
  
|
|
Broadcast List Functions |
|
Function Name: AddList
Inputs: Parm1 = UJP pathname
Parm2 = Pathname of list file
Returns: 0 = success
<0 = error
This function is deprecated: use InsertEnabledList instead (which this function now calls).
Function Name: DeleteList
This function deletes a list filename from the UJP. It can be used for all levels of UJP.
Inputs: Parm1 = UJP pathname
Parm3 = Index (base 1) of list to delete
Parm3 = 0 to delete all lists
Status: For an instance, must not be 24, 25, or >29
Returns: 0 = success
-1 = cannot lock UJP
-2 = cannot open UJP
-3 = cannot read UJP
-4 = cannot write UJP
-6 = instance not at correct status
-7 = list not found at index
Function Name: DisableList, EnableList
These functions enable and disable a list filename in the UJP. It can be used for all levels of UJP.
Inputs: Parm1 = UJP pathname
Parm3 = Index (base 1) of list to modify
Status: For an instance, must not be 24, 25, or >29.
Returns: 0 = success
-1 = cannot lock UJP
-2 = cannot open UJP
-3 = cannot read UJP
-4 = cannot write UJP
-6 = instance not at correct status
-7 = list not found at index
Function Name: GetListCount
This function returns the count of lists in the passed UJP
Inputs: Parm1 = UJP pathname
Status: Not checked
Returns: non-negative: count of lists
-1 = cannot lock UJP
-2 = cannot open UJP
-3 = cannot read UJP
Function Name: GetListPath
This function returns a list pathname, with a return code recording whether the requested list is enabled.
Inputs: Parm1 = UJP pathname
Parm3 = Index (base 1) of list to return
Status: Not checked
Outputs: Parm2 = List Pathname
Returns: 0 = for disabled list
1 = for enabled list
-1 = cannot lock UJP
-2 = cannot open UJP
-3 = cannot read UJP
-7 = list not found at index
Function Name: InsertDisabledList, InsertEnabledList
This function inserts a list filename into the UJP. It can be used for all levels of UJP. Note a duplicate list will not be detected if the same list is referenced by different valid pathnames. The function does not check that the list file exists.
Inputs: Parm1 = UJP pathname
Parm2 = Pathname of list file
Parm3 = Index (base 1) to insert list ahead of
Status: For an instance, must not be 24, 25, or >29.
Returns: 0 = success
-1 = cannot lock UJP
-2 = cannot open UJP
-3 = cannot read UJP
-4 = cannot write UJP
-5 = duplicate list name
-6 = instance not at correct status
Function Name: SaveLists
Inputs: Parm1 = Instance UJP pathname
Parm2 = String of 0s and 1s (1=use, 0=omit)
Status: For an instance, must not be 24, 25, or >29.
Returns: 0 = success
<0 = error
Update the list selections in Job Instance UJP. The second parameter is a string of 0 and 1 characters to indicate which lists should be disabled/enabled. This format is used to match the selection method in Job Admin IVR.
Topic url: http://www.copia.com/support/refmanual/index.html?job_admin_broadcast_list_funct.htm