ihuPublishGetTagPropertiesToCache

Use the ihuPublishGetTagPropertiesToCache function to retrieve a list of tags published by the specified Server-to-Server Distributor. Be sure to match tags with the exact tag name or a name with a specified wildcard mask.

Note: A separate published tag properties cache exists for each process thread. To avoid confusion and unexpected results, ensure that all cache-related function calls are invoked on the same thread. When threads are mixed, two or more distinct caches are referenced, which enables concurrent access to multiple different cached results at the cost of additional memory.

Prototype

ihuPublishGetTagPropertiesToCache
( long hServer,
  MSO Char *DistributorName,
  MSO Char *DestinationTagnameOrMask,
  out int *NumTagsFound
);

Remarks

The ihuPublishGetTagPropertiesToCache function returns the number of tags found in the NumTagsFound parameter.

Use this function to retrieve tags before you get and set string or numeric tag properties by using the ihuPublishTagGetNumericPropertyByTagname or ihuPublishTagSetStringProperty and similar functions.

Returns

The ihuPublishGetTagPropertiesToCache function returns ihuSTATUS_OK on success, even if no tags are found. The function returns errors if any out-of-memory issues occur during dynamic memory allocation.