Unix
Mac OS X
Windows
Options
Unix
Windows

# Module keyring Methods

## AcquireKeyringInfo

AcquireKeyringInfo() allocates the KeyringInfo structure.

The format of the AcquireKeyringInfo method is:

      KeyringInfo *AcquireKeyringInfo(const char *path)

A description of each parameter follows:

##### path

The keyring path.

## DestroyKeyringInfo

DestroyKeyringInfo() zeros memory associated with the KeyringInfo structure.

The format of the DestroyKeyringInfo method is:

      KeyringInfo *DestroyKeyringInfo(KeyringInfo *keyring_info)

A description of each parameter follows:

##### keyring_info

The ring info.

## ExportKeyringKey

ExportKeyringKey() exports a key from the keyring.

The format of the ExportKeyringKey method is:

      WizardBooleanType ExportKeyringKey(KeyringInfo *keyring_info,
        ExceptionInfo *exception)

A description of each parameter follows:

##### keyring_info

The ring info.

##### exception

Return any errors or warnings in this structure.

## GetKeyringKey

GetKeyringKey() returns the keyring key.

The format of the GetKeyringKey method is:

      const StringInfo *GetKeyringKey(const KeyringInfo *keyring_info)

A description of each parameter follows:

##### keyring_info

The keyring info.

## GetKeyringNonce

GetKeyringNonce() returns the keyring nonce.

The format of the GetKeyringNonce method is:

      const StringInfo *GetKeyringNonce(const KeyringInfo *keyring_info)

A description of each parameter follows:

##### keyring_info

The keyring info.

## ImportKeyringKey

ImportKeyringKey() imports a key to the keyring.

The format of the ImportKeyringKey method is:

      WizardBooleanType ImportKeyringKey(KeyringInfo *keyring_info,
        ExceptionInfo *exception)

A description of each parameter follows:

##### keyring_info

The ring info.

##### exception

Return any errors or warnings in this structure.

## PrintKeyringProperties

PrintKeyringProperties() prints properties associated with each key in the keyring.

The format of the PrintKeyringProperties method is:

      WizardBooleanType PrintKeyringProperties(const char *path,
        BlobInfo *keyring_blob,ExceptionInfo *exception)

A description of each parameter follows:

##### path

the keyring path.

##### blob_ibfo

list the key properties to this blob.

##### exception

Return any errors or warnings in this structure.

## SetKeyringId

SetKeyringId() sets the keyring id.

The format of the SetKeyringId method is:

      void SetKeyringId(KeyringInfo *keyring_info,const StringInfo *id)

A description of each parameter follows:

##### keyring_info

The keyring info.

##### id

The id.

## SetKeyringKey

SetKeyringKey() sets the keyring key.

The format of the SetKeyringKey method is:

      void SetKeyringKey(KeyringInfo *keyring_info,const StringInfo *key)

A description of each parameter follows:

##### keyring_info

The keyring info.

##### key

The key.

## SetKeyringNonce

SetKeyringNonce() sets the keyring nonce.

The format of the SetKeyringNonce method is:

      void SetKeyringNonce(KeyringInfo *keyring_info,const StringInfo *nonce)

A description of each parameter follows:

##### keyring_info

The keyring info.

##### nonce

The nonce.

## SetKeyringPath

SetKeyringPath() sets the keyring path.

The format of the SetKeyringPath method is:

      void SetKeyringPath(KeyringInfo *keyring_info,const char *path)

A description of each parameter follows:

##### keyring_info

The keyring info.

##### path

The keyring path.

Discourse Server