Major API Changes from PCRE v2.4 to v2.5

Download PDF version of this faq: 2_4 to 2_5 API_Changes.pdf

“Load Balancer Class” and all the associated methods of that class are completely new to version 2.5:

1. getReportServerName()
   Returns the ip address of the report server to use using the default load channel name and the default load balancing algorithm of load-factor.
   
2. getReportServerName(int algorithm)
   Returns the ip address of the report server to use using the default load channel name and the supplied load balancing algorithm (LoadBalancer constant).
   
3. getReportServerName(java.lang.String chnlName)
   Returns the ip address of the report server to use using the supplied load channel name and the default load balancing algorithm of load-factor.
   
4. getReportServerName(java.lang.String chnlName, int algorithm)
   Returns the ip address of the report server to use using the supplied load channel name and the supplied load balancing algorithm (LoadBalancer constant).

"PCREJob" Class has received various improvements and added convenience methods:

1. OutputToExcel(int formatType, java.lang.String excelFileName)
   Convenience method for exporting to Excel format type, it is effectively the same as ExportToExcel and ExportTo
   
2. OutputToHTML (int formatType, java.lang.String htmlFileName)
   Convenience method for exporting to HTML format type, it is effectively the same as ExportToHTML and ExportTo
   
3. OutputToWord(int formatType, java.lang.String wordFileName )
   Convenience method for exporting to Microsoft Word format type, it is effectively the same as ExportToWord and ExportTo
   
4. SetPrivateData( )
   This method existed in 2.4, however in 2.5 additional functionality was added to this method by overloading this function. In 2.5 this method can now read an XML file from the file system and set private data to the table. (Please refer to the Java API Quick Reference for more detailed information)
   
5. SetNthParameterValue(int paramN, java.lang.String value)
   Set the nth parameter field in this job's report by passing a String which will be converted to the appropriate type.
   
6. GetParameterValue(java.lang.String parameterName)
   Get the value of a named parameter field. This function replaces the usual GetNParameterFields(), GetNthParameterValue() sequence of calls.
   
7. GetNthParameterValue(int paramN)
   Get the value of the nth parameter field in this job's report as a string regardless of data type.
   
8. SetParameterValue(java.lang.String parameterName, java.lang.String parameterValue)
   These are new functions added that take and return strings as inputs. Earlier these were difficult to use and required the "PCREParameterFieldInfo Class" and had to use earlier methods ( 2.4 ) GetParameterField( ).

**Note that all COM API changes are similar to the ones listed for the Java API