CapyKit/Documentation/Help/M_CapyKit_Helpers_CompressionHelper_CompressToString.md
2024-09-04 19:31:43 -05:00

38 lines
920 B
Markdown
Raw Blame History

This file contains invisible Unicode characters

This file contains invisible Unicode characters that are indistinguishable to humans but may be processed differently by a computer. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

# CompressToString Method
Compresses a given object to a string using `base64` encoding of `gzip` format.
## Definition
**Namespace:** <a href="N_CapyKit_Helpers.md">CapyKit.Helpers</a>
**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.2
**C#**
``` C#
public static string CompressToString(
Object obj
)
```
**F#**
``` F#
static member CompressToString :
obj : Object -> string
```
#### Parameters
<dl><dt>  <a href="https://learn.microsoft.com/dotnet/api/system.object" target="_blank" rel="noopener noreferrer">Object</a></dt><dd>The object.</dd></dl>
#### Return Value
<a href="https://learn.microsoft.com/dotnet/api/system.string" target="_blank" rel="noopener noreferrer">String</a>
A string in `base64` encoding.
## See Also
#### Reference
<a href="T_CapyKit_Helpers_CompressionHelper.md">CompressionHelper Class</a>
<a href="N_CapyKit_Helpers.md">CapyKit.Helpers Namespace</a>