ExpirePSRattrCacheItem

Top  Previous  Next

SOAP

ExpirePSRattrCacheItem( aHandle, aUserGroupName, aLoginName,

                        aProjectName, aStudyName, aReportName, aReportType,

                        aName, aObjType,

                        &aErrorMsg )

 

 

REST

/ExpirePSRattrCacheItem?Handle=<value>&UserGroup=<value>&UserLogin=<value>

                        &Project=<value>&Study=<value>&Report=<value>&ReportType=<value>

                        &Name=<value>&ObjType=<value>

returns ErrorMsg

 

 

Description: ExpirePSRattrCacheItem() Flags a cached PSRattr item as expired and no longer available.  This will cause the next request to load from the database instead of the cache.  

 

aHandle The value created in the call to Login().  

To indicate which PSRattr to expire, specify the following values.  PSRattr's may be referenced to the shared user, a specific user, a project, study or report.  

 aUserGroupName, aUserLogin - These are required values

aProjectName, aStudyName, aReportName, aReportType - Any or all of these may be specified or left blank

aName, aObjType - These are required.

&aErrorMsg is populated only if an error occurred that prevented the function from succeeding.  Otherwise, this parameter is empty.

 

Example: ExpirePSRattrCacheItem( lHandle, "DOT@NY", ".shared", "","","","",

                                                      "MySchematic", "schematic", &aHandle )