SiMX Help‎ > ‎The Target Platform‎ > ‎Objects‎ > ‎DS (Data Source)‎ > ‎

CallFunction


Common Objects


Description

This calls a function to act on the data source. The function is usually implemented on the server side in such languages as Transact-SQL for MS SQL Server or PL/SQL for Oracle.

Note: There's a number of different types of server side functions. Some of functions return a scalar value, but some are capable to return a whole table. This method only can calls functions which returns a scalar value.

Syntax

Function CallFunction( func_name, input_params )

Parameters

string func_name  - The name of the function to call
array input_params  - The input parameters (optional)

Return Values

variant - the function's return value

Example

Let's say we have created a function written in the Transact-SQL language:

CREATE FUNCTION [dbo].[fVal_MyFunc]( @par1 VARCHAR(500), @par2 INT )
RETURNS INT AS
BEGIN
    RETURN 42
END


To call that function we do the following:

Dim result
result = this.DSOut.CallFunction( "dbo.fVal_MyFunc", Array( "val1", 2 ) )