Get-KFData

Syntax

Get-KFData 
  [-Key] <string> 
  [-ThrowErrors[:$true]]

Support

>= kenaflow 1.0.0

Return

Object.

Description

This cmdlet retrieves the data persisted with Set-KFData.

You get a PowerShell object from the deserialized data that is retrieved from the SharePoint workflow data list. (The actual name of the list is specified in the workflow configuration file _wfconfig.ps1.)

If the requested object does not exist, then $null is returned. An exception is not thrown.

Parameters

[-Key] <string>

The key that is used to read the serialized data.

[-ThrowErrors[:$true]]

This is a default parameter for all kenaflow cmdlets. If set to $true (default!) the engine will pass exception within the cmdlet to the script for further handling.

Example

Set-KFData -Key "kenaflow" -Data @{"is" = "a workflow engine for SharePoint, Email and PowerShell"}
Write-KFLog (Get-KFData -Key "kenaflow")
Remove-KFData -Key "kenaflow"