NAVTOR SDK  v.3.0
Software Development Kit for fast and efficient development of ECDIS, ECS and generic marine applications
ISymbolCollection Class Referenceabstract

Symbol collection. More...

#include <sdl_interface.h>

Inherits ISDKComponent.

Public Member Functions

virtual SDKResult SDK_CALLTYPE EnumSymbolParameterNames (const SDKString &symbol_set_name, const SDKString &symbol_name, EnumSDKStringSP &parameter_names)=0 throw ()
 Lists all formal parameter names in the specified symbol. More...
 
virtual SDKResult SDK_CALLTYPE EnumSymbolNames (const SDKString *symbol_set_name, EnumSDKStringSP &symbol_set_names)=0 throw ()
 Lists all registered symbols for specified symbol set. More...
 
virtual SDKResult SDK_CALLTYPE EnumSymbolSetNames (EnumSDKStringSP &symbol_set_names)=0 throw ()
 Lists all registered symbol sets. More...
 

Detailed Description

Symbol collection.

Member Function Documentation

◆ EnumSymbolParameterNames()

virtual SDKResult SDK_CALLTYPE EnumSymbolParameterNames ( const SDKString &  symbol_set_name,
const SDKString &  symbol_name,
EnumSDKStringSP &  parameter_names 
)
throw (
)
pure virtual

Lists all formal parameter names in the specified symbol.

Parameters
symbol_set_name[in] Registered name of the symbol set.
symbol_name[in] Registered name of the symbol (SDL script).
parameter_names[out] Smart pointer to the IEnumSDKString interface.
Returns
kSDKResult_Succeeded if there are formal parameters in the specified script.

◆ EnumSymbolNames()

virtual SDKResult SDK_CALLTYPE EnumSymbolNames ( const SDKString *  symbol_set_name,
EnumSDKStringSP &  symbol_set_names 
)
throw (
)
pure virtual

Lists all registered symbols for specified symbol set.

Parameters
symbol_set_name[in] Registered name of the symbol set.
symbol_set_names[out] Smart pointer to the IEnumSDKString interface.
Returns
kSDKResult_Succeeded if there are any symbols.

◆ EnumSymbolSetNames()

virtual SDKResult SDK_CALLTYPE EnumSymbolSetNames ( EnumSDKStringSP &  symbol_set_names)
throw (
)
pure virtual

Lists all registered symbol sets.

Parameters
symbol_set_names[out] Smart pointer to the IEnumSDKString interface.
Returns
kSDKResult_Succeeded if there are any symbol sets.

The documentation for this class was generated from the following file: