FormControl.securityKey Method

Definition

Overloads

securityKey()

Sets or returns the ID of the security key for the control.

securityKey(Int32)

securityKey()

Sets or returns the ID of the security key for the control.

public:
 virtual int securityKey();
public virtual int securityKey ();
abstract member securityKey : unit -> int
override this.securityKey : unit -> int
Public Overridable Function securityKey () As Integer

Returns

The ID of the security key for the control; 0 (zero) if no security key is assigned to the control.

Remarks

The following example shows how to retrieve and assign a security key ID for a control.

DictSecurityKey dsk; 
securityKeyId ski; 
// objCtrl previously assigned. 
// Assign a security key ID to the control. 
objCtrl.securityKey(securitykeynum(AdminDaily)); 
// Retrieve the security key ID from the control. 
ski = objCtrl.securityKey(); 
if (ski != 0) 
{ 
    dsk = new DictSecurityKey(ski); 
    if (dsk) 
    { 
        print strfmt("Security Key ID: %1 Security Key Name: %2", 
                     ski, 
                     dsk.name()); 
    } 
}

Applies to

securityKey(Int32)

public:
 virtual int securityKey(int _value);
public virtual int securityKey (int _value);
abstract member securityKey : int -> int
override this.securityKey : int -> int
Public Overridable Function securityKey (_value As Integer) As Integer

Parameters

_value
Int32

The ID of the security key to assign to the control; optional.

Returns

Applies to