msiSysMetaModify ( msParam_t *  sysMetadata,
msParam_t *  value,
ruleExecInfo_t *  rei 
)
Description:
Modify system metadata.
Module:
core
Since:
after 2.4.1
Author:
Jean-Yves Nief
Date:
2011-01-05
Note:
This call should only be used through the rcExecMyRule (irule) call i.e., rule execution initiated by clients and should not be called internally by the server since it interacts with the client through the normal client/server socket connection.
Example Usage:
See clients/icommands/test/rules3.0/
Parameters:
[in] sysMetadata - A STR_MS_T which specifies the system metadata to be modified. Allowed values are: "datatype", "comment", "expirytime". If one wants to modify only the sys metadata for one given replica, the value should be for example // JMC - backport 4573 "comment++++numRepl=2". It will only modify the comment for the replica number 2. If the syntax after "++++" is invalid, it will be ignored and all replica will be modified. This does not work for the "datatype" metadata.
[in] value - A STR_MS_T which specifies the value to be given to the system metadata.
[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:
0 upon success
Precondition:
N/A
Postcondition:
N/A
See also:
N/A

Definition at line 1744 of file reSysDataObjOpr.c.

Generated on Tue May 14 16:56:43 2013 for iRODS Documentation by  doxygen 1.6.3