---
product: Chilkat
product_version: 11.7.0
language: powerbuilder
language_label: PowerBuilder
class: XmlCertVault
license: free
deprecated: false
reference_html: https://www.chilkatsoft.com/refdoc/powerbuilder_XmlCertVaultRef.html
---
# Chilkat XmlCertVault — PowerBuilder — v11.7.0

> Chilkat 11.7.0 · language=powerbuilder · class=XmlCertVault
> Other versions: replace `11.7.0` in this URL. Other languages: `https://www.chilkatsoft.com/ai-docs/v/11.7.0/<lang>/classes/XmlCertVault.md`.
> Language-wide rules (install, unlock, error model, strings/bytes): `https://www.chilkatsoft.com/ai-docs/v/11.7.0/powerbuilder/guide.md`.

## Purpose

**Collect certificates, certificate chains, PEM data, and PFX private keys in an XML vault.**

`Chilkat.XmlCertVault` stores certificates and private-key material in a portable XML-based certificate vault. It can add individual certificates, certificate chains, DER or encoded certificates, PEM files, certificate strings, and PFX/PKCS12 data from files, memory, encoded text, or existing Chilkat objects. The vault can then be exported as XML, loaded from XML, or saved to an XML file for later reuse by other Chilkat certificate and TLS workflows.

**Add certificates**

Add certificates from `Cert` objects, files, PEM strings, binary DER bytes, or encoded data such as Base64 or hex.

**Add certificate chains**

Import an entire `CertChain` when related issuer and intermediate certificates should be kept together in the vault.

**Add PEM content**

Load PEM files containing one or more certificates and/or private keys, including encrypted PEM content when a password is supplied.

**Add PFX / PKCS12**

Add PFX data from a `Pfx` object, file, byte array, or encoded string, using the PFX password to import private-key material.

**Master password protection**

Use `MasterPassword` to protect access to private keys stored in the vault.

**Load and save XML**

Export the vault with `GetXml`, load it with `LoadXml` or `LoadXmlFile`, and persist it with `SaveXml`.

**Common pattern:** Create an `XmlCertVault`, set `MasterPassword` when the vault will contain private keys, add certificates or PFX/PEM material, then save the vault with `SaveXml` or keep the XML string from `GetXml`. Later, reload the same vault with `LoadXml` or `LoadXmlFile` and provide the same master password before using private keys.

**Security note:** Certificates are stored unencrypted, but private keys are stored using 256-bit AES encryption. The individual PFX passwords are also stored encrypted with the vault's `MasterPassword`, which is required to access any private keys contained in the XML vault.

## Object creation, unlocking and error handling

**Object Creation**

```powerbuilder
oleobject loo_XmlCertVault
integer li_rc

loo_XmlCertVault = create oleobject
li_rc = loo_XmlCertVault.ConnectToNewObject("Chilkat.XmlCertVault")
if li_rc < 0 then
    destroy loo_XmlCertVault
    MessageBox("Error","Connecting to COM object failed")
    return
end if

// ... use loo_XmlCertVault ...

destroy loo_XmlCertVault
```

PowerBuilder uses the Chilkat ActiveX through an `oleobject`: declare the variable, `create` it, connect it to the Chilkat class with `ConnectToNewObject`, and `destroy` it when finished. A negative return code from `ConnectToNewObject` means the ActiveX is not registered, or the registered ActiveX does not match the bitness (32-bit or 64-bit) of the PowerBuilder target.

Objects returned by methods (such as an `HttpResponse` or `JsonObject`) are also `oleobject` variables and must likewise be destroyed. A method that fails to return an object returns `null`; test with `IsNull()`. In the signatures on this page, the Chilkat class name identifies which object is expected or returned; the PowerBuilder variable type is always `oleobject`.

To bind to a specific major version of Chilkat, append the major version number to the ProgID, such as `ConnectToNewObject("Chilkat.XmlCertVault.11")` for Chilkat v11.\*.\*.

Members typed `blob` exchange binary data as a Variant byte array. The PowerBuilder examples instead use the `BinData`-based alternatives (methods ending in *Bd*), which keep binary data inside Chilkat objects.

Call `Global.UnlockBundle` once at the start of the program, before using this or any other Chilkat class. Any string unlocks a fully functional 30-day trial; a purchased unlock code is used in production. See `guide.md` for the exact code in PowerBuilder.

How failure is reported depends on the method's return type and is stated in the note under each method below. In every case the diagnostic text is in the `LastErrorText` property of the object whose method was called.

## Members common to every Chilkat class

Documented once per language in `common-members.md`; listed here so this page is self-contained.

| Property | Signature | Access | Meaning |
|---|---|---|---|
| `DebugLogFilePath` | `string DebugLogFilePath` | read/write | If set to a file path, this property logs the LastErrorText of each Chilkat method or property call to the specified file. |
| `LastBinaryResult` | `blob LastBinaryResult (read-only)` | read-only | This property is mainly used in SQL Server stored procedures to retrieve binary data from the last method call that returned binary data. |
| `LastErrorHtml` | `string LastErrorHtml (read-only)` | read-only | Provides HTML-formatted information about the last called method or property. |
| `LastErrorText` | `string LastErrorText (read-only)` | read-only | Provides plain text information about the last called method or property. |
| `LastErrorXml` | `string LastErrorXml (read-only)` | read-only | Provides XML-formatted information about the last called method or property. |
| `LastMethodSuccess` | `long LastMethodSuccess` | read/write | Indicates the success or failure of the most recent method call: `1` means success, `0` means failure. |
| `LastStringResult` | `string LastStringResult (read-only)` | read-only | In SQL Server stored procedures, this property holds the string return value of the most recent method call that returns a string. |
| `LastStringResultLen` | `long LastStringResultLen (read-only)` | read-only | The length, in characters, of the string contained in the LastStringResult property. |
| `VerboseLogging` | `long VerboseLogging` | read/write | If set to `1`, then the contents of LastErrorText (or LastErrorXml, or LastErrorHtml) may contain more verbose information. |
| `Version` | `string Version (read-only)` | read-only | Version of the component/library, such as "10.1.0" |

## Member index

| Member | Kind | Signature |
|---|---|---|
| `MasterPassword` | property, read/write | `string MasterPassword` |
| `AddCert` | method | `long AddCert(ChilkatCert cert)` |
| `AddCertBinary` | method | `long AddCertBinary(blob certBytes)` |
| `AddCertChain` | method | `long AddCertChain(ChilkatCertChain certChain)` |
| `AddCertEncoded` | method | `long AddCertEncoded(string encodedBytes, string encoding)` |
| `AddCertFile` | method | `long AddCertFile(string path)` |
| `AddCertString` | method | `long AddCertString(string certData)` |
| `AddPemFile` | method | `long AddPemFile(string path, string password)` |
| `AddPfx` | method | `long AddPfx(ChilkatPfx pfx)` |
| `AddPfxBinary` | method | `long AddPfxBinary(blob pfxBytes, string password)` |
| `AddPfxEncoded` | method | `long AddPfxEncoded(string encodedBytes, string encoding, string password)` |
| `AddPfxFile` | method | `long AddPfxFile(string path, string password)` |
| `GetXml` | method | `string GetXml()` |
| `LoadXml` | method | `long LoadXml(string xml)` |
| `LoadXmlFile` | method | `long LoadXmlFile(string path)` |
| `SaveXml` | method | `long SaveXml(string path)` |

## Properties

### XmlCertVault.MasterPassword

`Chilkat 11.7.0 · powerbuilder · XmlCertVault · MasterPassword · property · read/write · since 9.5.0.40`

```powerbuilder
string MasterPassword
```

The master password for the vault. Certificates are stored unencrypted, but private keys are stored 256-bit AES encrypted using the individual PFX passwords. The PFX passwords are stored 256-bit AES encrypted using the master password. The master password is required to acces any of the private keys stored within the XML vault.

## Methods

### XmlCertVault.AddCert

`Chilkat 11.7.0 · powerbuilder · XmlCertVault · AddCert · method · since 9.5.0.40`

```powerbuilder
long AddCert(ChilkatCert cert)
```

Adds a certificate to the XML vault.

Returns 1 for success, 0 for failure.

### XmlCertVault.AddCertBinary

`Chilkat 11.7.0 · powerbuilder · XmlCertVault · AddCertBinary · method · since 9.5.0.40`

```powerbuilder
long AddCertBinary(blob certBytes)
```

Adds a certificate to the XML vault from any binary format, such as DER.

Returns 1 for success, 0 for failure.

### XmlCertVault.AddCertChain

`Chilkat 11.7.0 · powerbuilder · XmlCertVault · AddCertChain · method · since 9.5.0.40`

```powerbuilder
long AddCertChain(ChilkatCertChain certChain)
```

Adds a chain of certificates to the XML vault.

Returns 1 for success, 0 for failure.

### XmlCertVault.AddCertEncoded

`Chilkat 11.7.0 · powerbuilder · XmlCertVault · AddCertEncoded · method · since 9.5.0.40`

```powerbuilder
long AddCertEncoded(string encodedBytes, string encoding)
```

Adds a certificate to the XML vault where certificate is passed directly from encoded bytes (such as Base64, Hex, etc.). The encoding is indicated by `encoding`.

Returns 1 for success, 0 for failure.

### XmlCertVault.AddCertFile

`Chilkat 11.7.0 · powerbuilder · XmlCertVault · AddCertFile · method · since 9.5.0.40`

```powerbuilder
long AddCertFile(string path)
```

Adds a certificate to the XML vault.

Returns 1 for success, 0 for failure.

### XmlCertVault.AddCertString

`Chilkat 11.7.0 · powerbuilder · XmlCertVault · AddCertString · method · since 9.5.0.40`

```powerbuilder
long AddCertString(string certData)
```

Adds a certificate from any string representation format such as PEM.

Returns 1 for success, 0 for failure.

### XmlCertVault.AddPemFile

`Chilkat 11.7.0 · powerbuilder · XmlCertVault · AddPemFile · method · since 9.5.0.40`

```powerbuilder
long AddPemFile(string path, string password)
```

Adds the contents of a PEM file to the XML vault. The PEM file may be encrypted, and it may contain one or more certificates and/or private keys. The password is optional and only required if the PEM file contains encrypted content that requires a password.

Returns 1 for success, 0 for failure.

### XmlCertVault.AddPfx

`Chilkat 11.7.0 · powerbuilder · XmlCertVault · AddPfx · method · since 9.5.0.40`

```powerbuilder
long AddPfx(ChilkatPfx pfx)
```

Adds a PFX (PKCS12) to the XML vault.

Returns 1 for success, 0 for failure.

### XmlCertVault.AddPfxBinary

`Chilkat 11.7.0 · powerbuilder · XmlCertVault · AddPfxBinary · method · since 9.5.0.40`

```powerbuilder
long AddPfxBinary(blob pfxBytes, string password)
```

Adds a PFX to the XML vault where PFX is passed directly from in-memory binary bytes.

Returns 1 for success, 0 for failure.

### XmlCertVault.AddPfxEncoded

`Chilkat 11.7.0 · powerbuilder · XmlCertVault · AddPfxEncoded · method`

```powerbuilder
long AddPfxEncoded(string encodedBytes, string encoding, string password)
```

Adds a PFX to the XML vault where PFX is passed directly from encoded bytes (such as Base64, Hex, etc.). The encoding is indicated by `encoding`.

Returns 1 for success, 0 for failure.

### XmlCertVault.AddPfxFile

`Chilkat 11.7.0 · powerbuilder · XmlCertVault · AddPfxFile · method · since 9.5.0.40`

```powerbuilder
long AddPfxFile(string path, string password)
```

Adds a PFX file to the XML vault.

Returns 1 for success, 0 for failure.

### XmlCertVault.GetXml

`Chilkat 11.7.0 · powerbuilder · XmlCertVault · GetXml · method · since 9.5.0.40`

```powerbuilder
string GetXml()
```

Returns the contents of the cert vault as an XML string.

Returns `null` on failure

### XmlCertVault.LoadXml

`Chilkat 11.7.0 · powerbuilder · XmlCertVault · LoadXml · method · since 9.5.0.40`

```powerbuilder
long LoadXml(string xml)
```

Loads from an XML string.

Returns 1 for success, 0 for failure.

### XmlCertVault.LoadXmlFile

`Chilkat 11.7.0 · powerbuilder · XmlCertVault · LoadXmlFile · method · since 9.5.0.40`

```powerbuilder
long LoadXmlFile(string path)
```

Loads from an XML file.

Returns 1 for success, 0 for failure.

### XmlCertVault.SaveXml

`Chilkat 11.7.0 · powerbuilder · XmlCertVault · SaveXml · method · since 9.5.0.40`

```powerbuilder
long SaveXml(string path)
```

Saves the contents to an XML file.

Returns 1 for success, 0 for failure.

## Related classes

[`Cert`](https://www.chilkatsoft.com/ai-docs/v/11.7.0/powerbuilder/classes/Cert.md), [`CertChain`](https://www.chilkatsoft.com/ai-docs/v/11.7.0/powerbuilder/classes/CertChain.md), [`Pfx`](https://www.chilkatsoft.com/ai-docs/v/11.7.0/powerbuilder/classes/Pfx.md)

