Status/Resolution/Reason: Closed/Fixed/Fixed
Reporter/Name(from Bugbase): Aaron Neff / ()
Created: 04/26/2018
Components: Documentation
Versions: 2018
Failure Type: Conflict With Docs
Found In Build/Fixed In Build: 2018.0.01.308605 / docs
Priority/Frequency: Normal / Some users will encounter
Locale/System: / Platforms All
Vote Count: 0
Issue: CacheGetProperties() doc is outdated
This:
-----------
An Array of structures containing the cache properties. Each structure has the properties for the cache type: object or page. If you specify either type in the parameter, the array has a single structure entry. Each structure has the following fields:
-----------
should be:
-----------
An array of structures, or a single structure, containing the cache properties. Each structure has the properties for the cache type: object, template or query. If you specify the region parameter, the single structure is not wrapped in an array. Each structure has the following fields:
-----------
Notes:
1) 'Array' should be 'array' (doesn't need capitalized)
2) ", or a single structure, " needs added, b/c the struct isn't wrapped in an array when returning properties for a single cache type
3) "object or page" should be "object, template or query", b/c query is also returned and 'page' is referred to as 'template'
4) "either type in the parameter" should be "the region parameter"
5) "the array has a single structure entry" should be "the single structure is not wrapped in an array"
In the Returns table, the description for "objecttype" should be changed from:
-----------
The cache type: object or template.
-----------
to:
-----------
The cache type: object, template or query.
-----------
Under the syntax, the following note is no longer valid and should be removed:
-----------
Note: If you call CacheGetProperties without any parameters, only data for the OBJECT cache is returned. To get the results for the TEMPLATE cache, you have to call cacheGetProperties(template)
-----------Attachments:
Comments: