msiSubstr ( msParam_t *  stringIn,
msParam_t *  offset,
msParam_t *  length,
msParam_t *  stringOut,
ruleExecInfo_t *  rei 
)
Description:
Returns a substring of the given string.
Module:
core
Since:
after 2.4
Author:
Mike Wan
Date:
2010
Example Usage:
See clients/icommands/test/rules3.0/
Parameters:
[in] stringIn - a STR_MS_T which specifies the input string.
[in] offset - a STR_MS_T which specifies the position of the beginning of the substring (0 is first character). If negative, then offset specifies the position from the end of the string (-1 is the last character).
[in] length - a STR_MS_T which specifies the length of substring to return. If length is not specified, too large, negative, or "null", then return the substring from the offset to the end of stringIn.
[out] stringOut - a STR_MS_T to hold the resulting substring.
[in,out] rei - The RuleExecInfo structure that is automatically handled by the rule engine. The user does not include rei as a parameter in the rule invocation.
Session Variables Used:
none
Session Variables Modified:
none
iCAT Attributes Used:
none
iCAT Attributes Modified:
none
Side Effect:
none
Returns:
integer
Return values:
the length of the substring
Precondition:
none
Postcondition:
none
See also:
none

Definition at line 625 of file msiHelper.c.

Generated on Sat Nov 16 22:27:08 2013 for iRODS Documentation by  doxygen 1.6.3