mirror of
https://github.com/wagesj45/CapyKit.git
synced 2024-10-18 15:01:52 -05:00
Jordan Wages
735d7c4c91
Committing the unfinished changes to the SecurityHelper as I flesh it out during the migration. Also starting a documentation folder powered by Sandcastle.
52 lines
1.1 KiB
Markdown
52 lines
1.1 KiB
Markdown
# Compress Method
|
||
|
||
|
||
Compresses a given object using the `gzip` algorithm.
|
||
|
||
|
||
|
||
## Definition
|
||
**Namespace:** <a href="N_CapyKit_Helpers">CapyKit.Helpers</a>
|
||
**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0+6cdd805be49c3b769a116584ea6904955ecd820d
|
||
|
||
**C#**
|
||
``` C#
|
||
public static byte[] Compress(
|
||
Object obj
|
||
)
|
||
```
|
||
**VB**
|
||
``` VB
|
||
Public Shared Function Compress (
|
||
obj As Object
|
||
) As Byte()
|
||
```
|
||
**C++**
|
||
``` C++
|
||
public:
|
||
static array<unsigned char>^ Compress(
|
||
Object^ obj
|
||
)
|
||
```
|
||
**F#**
|
||
``` F#
|
||
static member Compress :
|
||
obj : Object -> byte[]
|
||
```
|
||
|
||
|
||
|
||
#### 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.byte" target="_blank" rel="noopener noreferrer">Byte</a>[]
|
||
A byte array representing the compressed object in `gzip` format.
|
||
|
||
## See Also
|
||
|
||
|
||
#### Reference
|
||
<a href="T_CapyKit_Helpers_CompressionHelper">CompressionHelper Class</a>
|
||
<a href="N_CapyKit_Helpers">CapyKit.Helpers Namespace</a>
|