Virtru SDK for C#  2.8.0
Virtru C# SDK module - Create, Read, and Manage TDF3 Files
 All Classes Namespaces Files Functions Variables Enumerations Enumerator Properties Pages
Static Public Member Functions | Static Public Attributes | Properties | List of all members
Virtru.SDK.virtru Class Reference

Static Public Member Functions

static
SWIGTYPE_p_VEncryptFileParamsPtr 		VEncryptFileParamsCreate1 (string inFilePath)
 
static
SWIGTYPE_p_VEncryptFileParamsPtr 		VEncryptFileParamsCreate2 (string inFilePath, string outFilePath)
 
static void VEncryptFileParamsDestroy (SWIGTYPE_p_VEncryptFileParamsPtr vEncryptFileParamsPtr)
 
static SWIGTYPE_p_VSTATUS VEncryptFileParamsSetMimeType (SWIGTYPE_p_VEncryptFileParamsPtr vEncryptFileParamsPtr, string mimeType)
 
static SWIGTYPE_p_VSTATUS VEncryptFileParamsSetPolicy (SWIGTYPE_p_VEncryptFileParamsPtr vEncryptFileParamsPtr, SWIGTYPE_p_VPolicyPtr vPolicyPtr)
 
static SWIGTYPE_p_VSTATUS VEncryptFileParamsSetDisplayName (SWIGTYPE_p_VEncryptFileParamsPtr vEncryptFileParamsPtr, string displayName)
 
static SWIGTYPE_p_VSTATUS VEncryptFileParamsSetDisplayMessage (SWIGTYPE_p_VEncryptFileParamsPtr vEncryptFileParamsPtr, string displayMessage)
 
static SWIGTYPE_p_VSTATUS VEncryptFileParamsShareWithUsers (SWIGTYPE_p_VEncryptFileParamsPtr vEncryptFileParamsPtr, SWIGTYPE_p_p_char users, uint usersCount)
 
static
SWIGTYPE_p_VEncryptStringParamsPtr 		VEncryptStringParamsCreate (SWIGTYPE_p_VCBytesPtr vBytesPtr, SWIGTYPE_p_VBytesLength vBytesLength)
 
static void VEncryptStringParamsDestroy (SWIGTYPE_p_VEncryptStringParamsPtr vEncryptStringParamsPtr)
 
static SWIGTYPE_p_VSTATUS VEncryptStringParamsSetMimeType (SWIGTYPE_p_VEncryptStringParamsPtr vEncryptStringParamsPtr, string mimeType)
 
static SWIGTYPE_p_VSTATUS VEncryptStringParamsSetPolicy (SWIGTYPE_p_VEncryptStringParamsPtr vEncryptStringParamsPtr, SWIGTYPE_p_VPolicyPtr vPolicyPtr)
 
static SWIGTYPE_p_VSTATUS VEncryptStringParamsSetDisplayName (SWIGTYPE_p_VEncryptStringParamsPtr vEncryptStringParamsPtr, string displayName)
 
static SWIGTYPE_p_VSTATUS VEncryptStringParamsSetDisplayMessage (SWIGTYPE_p_VEncryptStringParamsPtr vEncryptStringParamsPtr, string displayMessage)
 
static SWIGTYPE_p_VSTATUS VEncryptStringParamsShareWithUsers (SWIGTYPE_p_VEncryptStringParamsPtr vEncryptStringParamsPtr, SWIGTYPE_p_p_char users, uint usersCount)
 

Static Public Attributes

static readonly int SWIG = virtruPINVOKE.SWIG_get()
 
static readonly int SWIG_CSHARP = virtruPINVOKE.SWIG_CSHARP_get()
 

Properties

static SWIGTYPE_p_uint32_t kNTDFMaxKeyIterations [get]
 

Member Function Documentation

static SWIGTYPE_p_VEncryptFileParamsPtr Virtru.SDK.virtru.VEncryptFileParamsCreate1 ( string  inFilePath)
inlinestatic

/ Create a new encrypt file param opaque object. / NOTE: The out file path will have .html/.tdf extension appended to / inFilePath based on protocol. / 

   ///  @param inFilePath - The file on which the encryption is performed

/

Returns
VEncryptFileParams opaque object. / NOTE: On failure returns NULL ptr.

/

static SWIGTYPE_p_VEncryptFileParamsPtr Virtru.SDK.virtru.VEncryptFileParamsCreate2 ( string  inFilePath,
string  outFilePath 
)
inlinestatic

/ Create a new encrypt file param opaque object. / 

   ///  @param inFilePath - The file on which the encryption is performed

/

Parameters
outFilePath- The file path of the tdf after successful encryption /
Returns
VEncryptFileParams opaque object. / NOTE: On failure returns NULL ptr.
/
static void Virtru.SDK.virtru.VEncryptFileParamsDestroy ( SWIGTYPE_p_VEncryptFileParamsPtr  vEncryptFileParamsPtr)
inlinestatic

/ Destruct the EncryptFileParams instance. / 

   ///  @param vEncryptFileParamsPtr - The pointer to EncryptFileParams opaque object.

/

static SWIGTYPE_p_VSTATUS Virtru.SDK.virtru.VEncryptFileParamsSetDisplayMessage ( SWIGTYPE_p_VEncryptFileParamsPtr  vEncryptFileParamsPtr,
string  displayMessage 
)
inlinestatic

/ Set the display message for the tdf, this message shows up on the Virtru dashboard / 

   ///  @param vEncryptFileParamsPtr - The pointer to EncryptFileParams opaque object.

/

Parameters
displayMessage- The display message for the tdf, null terminated string. /
Returns
VSTATUS - VSTATUS_SUCCESS on success
/
static SWIGTYPE_p_VSTATUS Virtru.SDK.virtru.VEncryptFileParamsSetDisplayName ( SWIGTYPE_p_VEncryptFileParamsPtr  vEncryptFileParamsPtr,
string  displayName 
)
inlinestatic

/ Set the display name for the tdf, this name shows up on the Virtru dashboard / NOTE: If not set, the basename of inFilePath will be used / 

   ///  @param vEncryptFileParamsPtr - The pointer to EncryptFileParams opaque object.

/

Parameters
displayName- The display name for the tdf, null terminated string. /
Returns
VSTATUS - VSTATUS_SUCCESS on success
/
static SWIGTYPE_p_VSTATUS Virtru.SDK.virtru.VEncryptFileParamsSetMimeType ( SWIGTYPE_p_VEncryptFileParamsPtr  vEncryptFileParamsPtr,
string  mimeType 
)
inlinestatic

/ The below methods are optional, if not specified the defaults are used. / / Set the mime type (format) of the file that will be encrypted / NOTE: The default will be 'application/octet-stream' if not specified / 

   ///  @param vEncryptFileParamsPtr - The pointer to EncryptFileParams opaque object.

/

Parameters
mimeType- The mime type of the file, null terminated string. /
Returns
VSTATUS - VSTATUS_SUCCESS on success
/
static SWIGTYPE_p_VSTATUS Virtru.SDK.virtru.VEncryptFileParamsSetPolicy ( SWIGTYPE_p_VEncryptFileParamsPtr  vEncryptFileParamsPtr,
SWIGTYPE_p_VPolicyPtr  vPolicyPtr 
)
inlinestatic

/ Set the policy that to be applied to the tdf / NOTE: If there is no policy defined for the tdf, default policy settings / will be applied / 

   ///  @param vEncryptFileParamsPtr - The pointer to EncryptFileParams opaque object.

/

Parameters
vPolicyPtr- The pointer to policy opaque object. /
Returns
VSTATUS - VSTATUS_SUCCESS on success
/
static SWIGTYPE_p_VSTATUS Virtru.SDK.virtru.VEncryptFileParamsShareWithUsers ( SWIGTYPE_p_VEncryptFileParamsPtr  vEncryptFileParamsPtr,
SWIGTYPE_p_p_char  users,
uint  usersCount 
)
inlinestatic

/ Add access to the TDF file/data for the users in the list / 

   ///  @param vEncryptFileParamsPtr - The pointer to EncryptFileParams opaque object.

/

Parameters
users- Share the TDF with the users in the users array /
usersCount- Total user count in the array. /
Returns
VSTATUS - VSTATUS_SUCCESS on success
/
static SWIGTYPE_p_VEncryptStringParamsPtr Virtru.SDK.virtru.VEncryptStringParamsCreate ( SWIGTYPE_p_VCBytesPtr  vBytesPtr,
SWIGTYPE_p_VBytesLength  vBytesLength 
)
inlinestatic

/ Create a new encrypt string param opaque object. / 

   ///  @param vBytesPtr - Const pointer to the data buffer.

/

Parameters
vBytesLength- The file on which the encryption is performed /
Returns
VEncryptStringParams opaque object. / NOTE: On failure returns NULL ptr.
/
static void Virtru.SDK.virtru.VEncryptStringParamsDestroy ( SWIGTYPE_p_VEncryptStringParamsPtr  vEncryptStringParamsPtr)
inlinestatic

/ Destruct the EncryptStringParams instance. / 

   ///  @param vEncryptStringParamsPtr - The pointer to EncryptStringParams opaque object.

/

static SWIGTYPE_p_VSTATUS Virtru.SDK.virtru.VEncryptStringParamsSetDisplayMessage ( SWIGTYPE_p_VEncryptStringParamsPtr  vEncryptStringParamsPtr,
string  displayMessage 
)
inlinestatic

/ Set the display message for the tdf, this message shows up on the Virtru dashboard / 

   ///  @param vEncryptStringParamsPtr - The pointer to EncryptStringParams opaque object.

/

Parameters
displayMessage- The display message for the tdf, null terminated string. /
Returns
VSTATUS - VSTATUS_SUCCESS on success
/
static SWIGTYPE_p_VSTATUS Virtru.SDK.virtru.VEncryptStringParamsSetDisplayName ( SWIGTYPE_p_VEncryptStringParamsPtr  vEncryptStringParamsPtr,
string  displayName 
)
inlinestatic

/ Set the display name for the tdf, this name shows up on the Virtru dashboard / NOTE: If not set, the basename of inFilePath will be used / 

   ///  @param vEncryptStringParamsPtr - The pointer to EncryptStringParams opaque object.

/

Parameters
displayName- The display name for the tdf, null terminated string. /
Returns
VSTATUS - VSTATUS_SUCCESS on success
/
static SWIGTYPE_p_VSTATUS Virtru.SDK.virtru.VEncryptStringParamsSetMimeType ( SWIGTYPE_p_VEncryptStringParamsPtr  vEncryptStringParamsPtr,
string  mimeType 
)
inlinestatic

/ The below methods are optional, if not specified the defaults are used. / / Set the mime type (format) of the file that will be encrypted / NOTE: The default will be 'application/octet-stream' if not specified / 

   ///  @param vEncryptStringParamsPtr - The pointer to EncryptStringParams opaque object.

/

Parameters
mimeType- The mime type of the file, null terminated string. /
Returns
VSTATUS - VSTATUS_SUCCESS on success
/
static SWIGTYPE_p_VSTATUS Virtru.SDK.virtru.VEncryptStringParamsSetPolicy ( SWIGTYPE_p_VEncryptStringParamsPtr  vEncryptStringParamsPtr,
SWIGTYPE_p_VPolicyPtr  vPolicyPtr 
)
inlinestatic

/ Set the policy that to be applied to the tdf / NOTE: If there is no policy defined for the tdf, default policy settings / will be applied / 

   ///  @param vEncryptStringParamsPtr - The pointer to EncryptStringParams opaque object.

/

Parameters
vPolicyPtr- The pointer to policy opaque object. /
Returns
VSTATUS - VSTATUS_SUCCESS on success
/
static SWIGTYPE_p_VSTATUS Virtru.SDK.virtru.VEncryptStringParamsShareWithUsers ( SWIGTYPE_p_VEncryptStringParamsPtr  vEncryptStringParamsPtr,
SWIGTYPE_p_p_char  users,
uint  usersCount 
)
inlinestatic

/ Add access to the TDF file/data for the users in the list / 

   ///  @param vEncryptStringParamsPtr - The pointer to EncryptStringParams opaque object.

/

Parameters
users- Share the TDF with the users in the users array /
usersCount- Total user count in the array. /
Returns
VSTATUS - VSTATUS_SUCCESS on success
/

Member Data Documentation

readonly int Virtru.SDK.virtru.SWIG = virtruPINVOKE.SWIG_get()
static
readonly int Virtru.SDK.virtru.SWIG_CSHARP = virtruPINVOKE.SWIG_CSHARP_get()
static

Property Documentation

SWIGTYPE_p_uint32_t Virtru.SDK.virtru.kNTDFMaxKeyIterations
staticget
The documentation for this class was generated from the following file: