Method GetKeys

Namespace

Skyline.DataMiner.Scripting

Assembly

SLManagedScripting.dll

GetKeys(SLProtocol, int, KeyType)

Gets the primary keys or display keys of the specified table.

[Obsolete("Use protocol.GetKeys instead", false)]
public static string[] GetKeys(SLProtocol protocol, int tableId, NotifyProtocol.KeyType type = KeyType.Index)

Parameters

protocol SLProtocol

Instance that implements SLProtocol.

tableId int

The ID of the table parameter.

type NotifyProtocol.KeyType

Specify KeyType.DisplayKey to retrieve the display keys.

Returns

string[]

The primary keys or display keys of the rows present in the table.

Remarks

Avoid using the GetKeys method to retrieve the primary keys (NotifyProtocol.KeyType.Index) for DataMiner versions prior to DataMiner 9.0. Up to DataMiner 9.0, the implementation to retrieve the primary keys is based on the SLElement process (a NotifyProtocol type 168 call NT_GET_INDEXES is executed, which retrieves both the primary keys and the display keys.).

From DataMiner version 9.0 onwards, the implementation of the GetKeys method has been updated, so that retrieving the primary keys no longer involves the SLElement process. (This now results in a NotifyProtocol type 397 call NT_GET_KEYS_SLPROTOCOL). However, note that obtaining the display keys(NotifyProtocol.KeyType.DisplayKey) is still based on SLElement(a NotifyProtocol type 168 call NT_GET_INDEXES).

GetKeys(SLProtocol, int)

Retrieves the primary keys of the specified table.

[Obsolete("Use protocol.GetKeys instead", false)]
public static string[] GetKeys(SLProtocol protocol, int tableId)

Parameters

protocol SLProtocol

Instance that implements SLProtocol.

tableId int

The ID of the table parameter

Returns

string[]

The primary keys of the rows present in the table.

Remarks

Avoid using the GetKeys method to retrieve the primary keys (NotifyProtocol.KeyType.Index) for DataMiner versions prior to DataMiner 9.0. Up to DataMiner 9.0, the implementation to retrieve the primary keys is based on the SLElement process (a NotifyProtocol type 168 call NT_GET_INDEXES is executed, which retrieves both the primary keys and the display keys.).

From DataMiner version 9.0 onwards, the implementation of the GetKeys method has been updated, so that retrieving the primary keys no longer involves the SLElement process. (This now results in a NotifyProtocol type 397 call NT_GET_KEYS_SLPROTOCOL). However, note that obtaining the display keys(NotifyProtocol.KeyType.DisplayKey) is still based on SLElement(a NotifyProtocol type 168 call NT_GET_INDEXES).