> For the complete documentation index, see [llms.txt](https://docs.medcrypt.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.medcrypt.com/api-reference/api-reference/namespaces/namespacemedcrypt-guardian-utilities.md).

# medcrypt::guardian::utilities

## Classes

|        | Name                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                |
| ------ | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| struct | <p><a href="https://github.com/MedCrypt/docs/tree/cc6d7e9e4565d200e300a7e4ea03af7b3d489502/Classes/structmedcrypt-guardian-utilities-InitializeFiles.md"><strong>medcrypt::guardian::utilities::InitializeFiles</strong></a> <br>Storage for initialization files used by <a href="https://github.com/MedCrypt/docs/tree/cc6d7e9e4565d200e300a7e4ea03af7b3d489502/Classes/classmedcrypt-guardian-Guardian.md#function-initialize">Guardian::Initialize</a>.</p>                                     |
| struct | <p><a href="https://github.com/MedCrypt/docs/tree/cc6d7e9e4565d200e300a7e4ea03af7b3d489502/Classes/structmedcrypt-guardian-utilities-ProvisionFiles.md"><strong>medcrypt::guardian::utilities::ProvisionFiles</strong></a> <br>Storage for generating provision request files in <a href="https://github.com/MedCrypt/docs/tree/cc6d7e9e4565d200e300a7e4ea03af7b3d489502/Classes/classmedcrypt-guardian-Guardian.md#function-generateprovisionrequest">Guardian::GenerateProvisionRequest</a>.</p>  |
| struct | <p><a href="https://github.com/MedCrypt/docs/tree/cc6d7e9e4565d200e300a7e4ea03af7b3d489502/Classes/structmedcrypt-guardian-utilities-ProvisionOnlineFiles.md"><strong>medcrypt::guardian::utilities::ProvisionOnlineFiles</strong></a> <br>Storage for online provisioning files in <a href="https://github.com/MedCrypt/docs/tree/cc6d7e9e4565d200e300a7e4ea03af7b3d489502/Classes/classmedcrypt-guardian-Guardian.md#function-startprovisioningonline">Guardian::StartProvisioningOnline</a>.</p> |

## Functions

|      | Name                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  |
| ---- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| bool | <p><a href="/api-reference/api-reference/namespaces/namespacemedcrypt-guardian-utilities.md#function-getinitializefilesfrompath"><strong>GetInitializeFilesFromPath</strong></a>(const std::string & in\_filespath, const bool & in\_use\_provision\_files, <a href="https://github.com/MedCrypt/docs/tree/cc6d7e9e4565d200e300a7e4ea03af7b3d489502/Classes/structmedcrypt-guardian-utilities-InitializeFiles.md">InitializeFiles</a> \* io\_files, const std::string & in\_prefix ="") <br>Populate file buffers required by <a href="https://github.com/MedCrypt/docs/tree/cc6d7e9e4565d200e300a7e4ea03af7b3d489502/Classes/classmedcrypt-guardian-Guardian.md#function-initialize">Guardian::Initialize</a> from path.</p>                         |
| void | <p><a href="/api-reference/api-reference/namespaces/namespacemedcrypt-guardian-utilities.md#function-deleteinitializefilebuffers"><strong>DeleteInitializeFileBuffers</strong></a>(<a href="https://github.com/MedCrypt/docs/tree/cc6d7e9e4565d200e300a7e4ea03af7b3d489502/Classes/structmedcrypt-guardian-utilities-InitializeFiles.md">InitializeFiles</a> \* io\_files) <br>Delete dynamic memroy in created by <a href="/api-reference/api-reference/namespaces/namespacemedcrypt-guardian-utilities.md#function-getinitializefilesfrompath">GetInitializeFilesFromPath()</a></p>                                                                                                                                                                 |
| bool | <p><a href="/api-reference/api-reference/namespaces/namespacemedcrypt-guardian-utilities.md#function-getprovisionfilesfrompath"><strong>GetProvisionFilesFromPath</strong></a>(const std::string & in\_filespath, const bool & in\_use\_provision\_files, <a href="https://github.com/MedCrypt/docs/tree/cc6d7e9e4565d200e300a7e4ea03af7b3d489502/Classes/structmedcrypt-guardian-utilities-ProvisionFiles.md">ProvisionFiles</a> \* io\_files, const std::string & in\_prefix ="") <br>Populate file buffers required by <a href="https://github.com/MedCrypt/docs/tree/cc6d7e9e4565d200e300a7e4ea03af7b3d489502/Classes/classmedcrypt-guardian-Guardian.md#function-generateprovisionrequest">Guardian::GenerateProvisionRequest</a> from path.</p> |
| void | <p><a href="/api-reference/api-reference/namespaces/namespacemedcrypt-guardian-utilities.md#function-deleteprovisionfilebuffers"><strong>DeleteProvisionFileBuffers</strong></a>(<a href="https://github.com/MedCrypt/docs/tree/cc6d7e9e4565d200e300a7e4ea03af7b3d489502/Classes/structmedcrypt-guardian-utilities-ProvisionFiles.md">ProvisionFiles</a> \* io\_files) <br>Delete dynamic memroy in created by <a href="/api-reference/api-reference/namespaces/namespacemedcrypt-guardian-utilities.md#function-getprovisionfilesfrompath">GetProvisionFilesFromPath()</a></p>                                                                                                                                                                       |

## Attributes

|            | Name                                                                                                                                        |
| ---------- | ------------------------------------------------------------------------------------------------------------------------------------------- |
| const char | [**kRequestExtension**](/api-reference/api-reference/namespaces/namespacemedcrypt-guardian-utilities.md#variable-krequestextension)         |
| const char | [**kProfileExtension**](/api-reference/api-reference/namespaces/namespacemedcrypt-guardian-utilities.md#variable-kprofileextension)         |
| const char | [**kRunProfileExtension**](/api-reference/api-reference/namespaces/namespacemedcrypt-guardian-utilities.md#variable-krunprofileextension)   |
| const char | [**kIdentityExtension**](/api-reference/api-reference/namespaces/namespacemedcrypt-guardian-utilities.md#variable-kidentityextension)       |
| const char | [**kRunIdentityExtension**](/api-reference/api-reference/namespaces/namespacemedcrypt-guardian-utilities.md#variable-krunidentityextension) |
| const char | [**kTrustExtension**](/api-reference/api-reference/namespaces/namespacemedcrypt-guardian-utilities.md#variable-ktrustextension)             |
| const char | [**kRevocationExtension**](/api-reference/api-reference/namespaces/namespacemedcrypt-guardian-utilities.md#variable-krevocationextension)   |

## Functions Documentation

### function GetInitializeFilesFromPath

```cpp
static inline bool GetInitializeFilesFromPath(
    const std::string & in_filespath,
    const bool & in_use_provision_files,
    InitializeFiles * io_files,
    const std::string & in_prefix =""
)
```

Populate file buffers required by [Guardian::Initialize](https://github.com/MedCrypt/docs/tree/cc6d7e9e4565d200e300a7e4ea03af7b3d489502/Classes/classmedcrypt-guardian-Guardian.md#function-initialize) from path.

**Parameters**:

* **in\_filespath** absolute or working directory relative path to profile files&#x20;
* **in\_use\_provision\_files** used to return provisioning profiles for initializing to run online provisioning&#x20;
* **io\_files** file structure to populate&#x20;
* **in\_prefix** prefix that each found file is required to have, allows multiple profile sets in the same folder separated by file prefix

**Returns**:

* **true** io\_files populated successfully&#x20;
* **false** io\_files not populated&#x20;

**Return**: bool

Searches for files in in\_filepath with prefix in\_prefix. Sorts alphanumerically after applying prefix and uses the first result.

Note: This function creates memory in [InitializeFiles](https://github.com/MedCrypt/docs/tree/cc6d7e9e4565d200e300a7e4ea03af7b3d489502/Classes/structmedcrypt-guardian-utilities-InitializeFiles.md) char\* buffers using new\[], its paired [DeleteInitializeFileBuffers()](/api-reference/api-reference/namespaces/namespacemedcrypt-guardian-utilities.md#function-deleteinitializefilebuffers) function will delete the created dynamic memory.

### function DeleteInitializeFileBuffers

```cpp
static inline void DeleteInitializeFileBuffers(
    InitializeFiles * io_files
)
```

Delete dynamic memroy in created by [GetInitializeFilesFromPath()](/api-reference/api-reference/namespaces/namespacemedcrypt-guardian-utilities.md#function-getinitializefilesfrompath)

**Parameters**:

* **io\_files** file structure to clean up

**Return**: none

Calls delete\[] on all [InitializeFiles](https://github.com/MedCrypt/docs/tree/cc6d7e9e4565d200e300a7e4ea03af7b3d489502/Classes/structmedcrypt-guardian-utilities-InitializeFiles.md) char\* buffers.

### function GetProvisionFilesFromPath

```cpp
static inline bool GetProvisionFilesFromPath(
    const std::string & in_filespath,
    const bool & in_use_provision_files,
    ProvisionFiles * io_files,
    const std::string & in_prefix =""
)
```

Populate file buffers required by [Guardian::GenerateProvisionRequest](https://github.com/MedCrypt/docs/tree/cc6d7e9e4565d200e300a7e4ea03af7b3d489502/Classes/classmedcrypt-guardian-Guardian.md#function-generateprovisionrequest) from path.

**Parameters**:

* **in\_filespath** absolute or working directory relative path to profile files&#x20;
* **in\_use\_provision\_files** used to return provisioning profiles, usually should be true&#x20;
* **io\_files** file structure to populate&#x20;
* **in\_prefix** prefix that each found file is required to have, allows multiple profile sets in the same folder separated by file prefix

**Returns**:

* **true** io\_files populated successfully&#x20;
* **false** io\_files not populated&#x20;

**Return**: bool

Searches for files in in\_filepath with prefix in\_prefix. Sorts alphanumerically after applying prefix and uses the first result.

Note: This function creates memory in [ProvisionFiles](https://github.com/MedCrypt/docs/tree/cc6d7e9e4565d200e300a7e4ea03af7b3d489502/Classes/structmedcrypt-guardian-utilities-ProvisionFiles.md) char\* buffers using new\[], its paired [DeleteProvisionFileBuffers()](/api-reference/api-reference/namespaces/namespacemedcrypt-guardian-utilities.md#function-deleteprovisionfilebuffers) function will delete the created dynamic memory.

Note: This function does not create memory for outputs [ProvisionFiles::ProvisionRequest](https://github.com/MedCrypt/docs/tree/cc6d7e9e4565d200e300a7e4ea03af7b3d489502/Classes/structmedcrypt-guardian-utilities-ProvisionFiles.md#variable-provisionrequest) or [ProvisionFiles::GeneratedPrivateIdentity](https://github.com/MedCrypt/docs/tree/cc6d7e9e4565d200e300a7e4ea03af7b3d489502/Classes/structmedcrypt-guardian-utilities-ProvisionFiles.md#variable-generatedprivateidentity)

### function DeleteProvisionFileBuffers

```cpp
static inline void DeleteProvisionFileBuffers(
    ProvisionFiles * io_files
)
```

Delete dynamic memroy in created by [GetProvisionFilesFromPath()](/api-reference/api-reference/namespaces/namespacemedcrypt-guardian-utilities.md#function-getprovisionfilesfrompath)

**Parameters**:

* **io\_files** file structure to clean up

**Return**: none

Calls delete\[] on all [ProvisionFiles](https://github.com/MedCrypt/docs/tree/cc6d7e9e4565d200e300a7e4ea03af7b3d489502/Classes/structmedcrypt-guardian-utilities-ProvisionFiles.md) char\* buffers except for outputs [ProvisionFiles::ProvisionRequest](https://github.com/MedCrypt/docs/tree/cc6d7e9e4565d200e300a7e4ea03af7b3d489502/Classes/structmedcrypt-guardian-utilities-ProvisionFiles.md#variable-provisionrequest) and [ProvisionFiles::GeneratedPrivateIdentity](https://github.com/MedCrypt/docs/tree/cc6d7e9e4565d200e300a7e4ea03af7b3d489502/Classes/structmedcrypt-guardian-utilities-ProvisionFiles.md#variable-generatedprivateidentity)

## Attributes Documentation

### variable kRequestExtension

```cpp
static const char kRequestExtension = ".mcpr";
```

Provision request file extension

### variable kProfileExtension

```cpp
static const char kProfileExtension = ".mcpp";
```

Certified provisioning profile file extension

### variable kRunProfileExtension

```cpp
static const char kRunProfileExtension = ".mcp";
```

Certified profile file extension

### variable kIdentityExtension

```cpp
static const char kIdentityExtension = ".mcpip";
```

Provisioning private identity file extension

### variable kRunIdentityExtension

```cpp
static const char kRunIdentityExtension = ".mcpi";
```

Private identity file extension

### variable kTrustExtension

```cpp
static const char kTrustExtension = ".mcts";
```

Trust store file extension

### variable kRevocationExtension

```cpp
static const char kRevocationExtension = ".mccrl";
```

Certificate revocation list file extension


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://docs.medcrypt.com/api-reference/api-reference/namespaces/namespacemedcrypt-guardian-utilities.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.