tibemsAdmin_GetTopics

Function

Purpose

Get the topics that match the given pattern and the given permanence type.

C Declaration

tibems_status tibemsAdmin_GetTopics(
    tibemsAdmin admin,
    tibemsCollection* collection,
    const char* pattern,
    tibems_int permType);

COBOL Call

CALL "tibemsAdmin_GetTopics"
 USING BY VALUE admin,
       BY REFERENCE collection,
       BY REFERENCE pattern,
       BY VALUE permType,
       RETURNING tibems-status
END-CALL.
Note: collection has usage pointer.

Parameters

Parameter Description
admin Get information about topics using this administrative connection.
collection Store the returned topic data in the location specified here, as a collection of tibemsTopicInfo objects.
pattern The topic name pattern that must be matched.

The pattern may contain the wildcards * and >. A pattern of > or NULL will return all topics.

permType The permanence type of the topic must match the type given here. Possible permanence types are:
  • TIBEMS_DEST_GET_ALL – Return all topics that match the pattern.
  • TIBEMS_DEST_GET_STATIC – Return only static topics that match the pattern.
  • TIBEMS_DEST_GET_DYNAMIC – Return only dynamic topics that match the pattern.
  • TIBEMS_DEST_GET_NOTEMP – Do not return any temporary topics.

A NULL value matches all topics.

Status Codes

Status Code Description
TIBEMS_TIMEOUT The administrative query timed out while waiting for a server response.
TIBEMS_NOT_FOUND No topics found matching the specified pattern and performance type.

See Also

tibemsTopicInfo