msiExtractTemplateMDFromBuf ( msParam_t *  bufParam,
msParam_t *  tagParam,
msParam_t *  metadataParam,
ruleExecInfo_t *  rei 
)
Description:
This microservice parses a buffer containing metadata and uses the tags to identify Key-Value Pairs.
Module:
core
Since:
pre-2.1
Author:
Arcot Rajasekar
Date:
2007-02-01
Remarks:
Terrell Russell - msi documentation, 2009-06-17
Note:
The template structure identifies triplets <pre-string-regexp,post-string-regexp,keyword> and the metadata buffer is searched for the pre and post regular expressions and the string between them is associated with the keyword. A.l <key,value> pairs found are stored in keyValPair_t structure.
Example Usage:
See clients/icommands/test/rules3.0/
Parameters:
[in] bufParam - a msParam of type BUF_MS_T
[in] tagParam - a msParam of type TagStruct_MS_T
[out] metadataParam - a msParam of type KeyValPair_MS_T
[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 on success
USER_PARAM_TYP_ERROR when input parameter doesn't match the type
INVALID_REGEXP if the tags are not correct
from addKeyVal
Precondition:
none
Postcondition:
none
See also:
addKeyVal

Definition at line 342 of file extractAvuMS.c.

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