\(\renewcommand\AA{\unicode{x212B}}\)
CatalogLogout v1¶
Enable screenshots using DOCS_SCREENSHOTS in CMake¶
Summary¶
Logs out all catalogs, or a specific catalog using the session information provided.
See Also¶
Properties¶
Name |
Direction |
Type |
Default |
Description |
|---|---|---|---|---|
Session |
Input |
string |
The session information of the catalog to log out. If none provided then all catalogs are logged out. |
Description¶
This algorithm logs a user out of all catalogs, or a specific catalog.
Usage¶
Example - logs a user out of the catalog.
# Logs the user out of the catalog and kills CatalogKeepAlive()
CatalogLogout()
# Logs the user out of a specific catalog, and kills the related CatalogKeepAlive()
# Assuming session is the return value of CatalogLogin()
CatalogLogout(session)
Categories: AlgorithmIndex | DataHandling\Catalog
Source¶
C++ header: CatalogLogout.h
C++ source: CatalogLogout.cpp