KeyPurpose Property

The key's purpose.

Syntax

ANSI (Cross Platform)
int GetKeyPurpose(int iKeyIndex);

Unicode (Windows)
INT GetKeyPurpose(INT iKeyIndex);

Possible Values

GKP_UNSPECIFIED(0), 
GKP_ENCRYPT_DECRYPT(1), 
GKP_ASYMMETRIC_SIGN(2), 
GKP_ASYMMETRIC_DECRYPT(3)
- (int)keyPurpose:(int)keyIndex;

Possible Values

GKP_UNSPECIFIED(0), 
GKP_ENCRYPT_DECRYPT(1), 
GKP_ASYMMETRIC_SIGN(2), 
GKP_ASYMMETRIC_DECRYPT(3)
#define PID_GOOGLEKMS_KEYPURPOSE 24

CLOUDKEYS_EXTERNAL void* CLOUDKEYS_CALL CloudKeys_GoogleKMS_Get(void *lpObj, int propid, int arridx, int *lpcbVal, int64 *lpllVal);

CLOUDKEYS_EXTERNAL int CLOUDKEYS_CALL CloudKeys_GoogleKMS_CheckIndex(void *lpObj, int propid, int arridx);

Default Value

0

Remarks

The key's purpose.

This property reflects the key's purpose. Possible values are:

  • gkpUnspecified (0)
  • gkpEncryptDecrypt (1) (indicates the key is symmetric)
  • gkpAsymmetricSign (2)
  • gkpAsymmetricDecrypt (3)

The KeyIndex parameter specifies the index of the item in the array. The size of the array is controlled by the KeyCount property.

This property is read-only and not available at design time.

Data Type

Integer
Copyright (c) 2022 /n software inc. - All rights reserved.
Cloud Keys 2020 C++ Edition - Version 20.0 [Build 8157]