Chilkat Examples

ChilkatHOMEAndroid™Classic ASPCC++C#Mono C#.NET Core C#C# UWP/WinRTDataFlexDelphi ActiveXDelphi DLLVisual FoxProJavaLianjaMFCObjective-CPerlPHP ActiveXPHP ExtensionPowerBuilderPowerShellPureBasicPythonRubySQL ServerSwiftTclUnicode CUnicode C++Visual Basic 6.0VB.NETVB.NET UWP/WinRTVBScriptXojo PluginNode.jsExcel

PowerShell Examples


ASN.1
Amazon S3
Amazon S3 (new)
Amazon SES
Amazon SNS
Amazon SQS
Async
Azure Cloud Storage
Azure Service Bus
Bounced Email
Box
CSR
CSV
Certificates
Compression
DKIM / DomainKey
DSA
Diffie-Hellman
Digital Signatures
Dropbox
ECC
Email Object
Encryption
FTP
Facebook
Firebase
GeoOp
Google APIs
Google Calendar
Google Cloud Storage
Google Drive
Gzip
HTML-to-XML/Text
HTTP
HTTP Misc
IMAP
JSON
JSON Web Encryption (JWE)
JSON Web Signatures (JWS)
JSON Web Token (JWT)

Java KeyStore (JKS)
MHT / HTML Email
MIME
Microsoft Graph
NTLM
OAuth1
OAuth2
OneDrive
OpenSSL
Outlook
PEM
PFX/P12
POP3
PRNG
PayPal
Peoplevox
QuickBooks
REST
RSA Encryption
SCP
SFTP
SMTP
SSH
SSH Key
SSH Tunnel
SharePoint
Shopify
Socket/SSL/TLS
Spider
Stream
Stripe
SugarCRM
Tar Archive
Twitter
VoiceBase
Walmart
WebSocket
XML
XML Digital Signatures
XMP
Xero
Zip
curl
eBay

 

 

 

(PowerShell) Starting an Asynchronous Task

Chilkat methods that have a name ending in "Async" return a task object. The task object can be run asynchronously on Chilkat's background thread pool. The purpose of this example is to demonstrate how a Task is started via the Run method. It also demonstrates how an application can check on the status of the task, and get the task return value. See the online reference documentation for the full details of the task and task chain objects. Also see the "Task" category on example-code.com for more examples.

Chilkat .NET Downloads

Chilkat .NET Assemblies

Chilkat for Mono

Chilkat for Xamarin

[Reflection.Assembly]::LoadFile("C:\myAssemblies\ChilkatDotNet2.dll")

#  All Chilkat classes can be unlocked at once at the beginning of a program
#  by calling UnlockBundle.  It requires a Bundle unlock code.
$chilkatGlob = New-Object Chilkat.Global
$success = $chilkatGlob.UnlockBundle("Anything for 30-day trial.")
if ($success -ne $true) {
    $($chilkatGlob.LastErrorText)
    exit
}

$mailman = New-Object Chilkat.MailMan

#  Set the SMTP server and any required settings.
$mailman.SmtpHost = "smtp.mymailserver.com"
$mailman.SmtpUsername = "myLogin"
$mailman.SmtpPassword = "myPassword"
$mailman.StartTLS = $true

#  Create a new email object
$email = New-Object Chilkat.Email

$email.Subject = "This is a test"
$email.Body = "This is a test"
$email.From = "Chilkat Support <support@chilkatsoft.com>"
$success = $email.AddTo("Chilkat Admin","admin@chilkatsoft.com")

#  Call the async version of the SendEmail method to return a task object.
#  The task object is loaded, but is in the Inert state -- meaning it is
#  not yet scheduled to run on Chilkat's background thread pool.
$task = $mailman.SendEmailAsync($email)
if ($task -eq $null ) {
    $($mailman.LastErrorText)
    exit
}

#  Schedule the task for running on the thread pool.  This changes the task's state
#  from Inert to Live.
$success = $task.Run()
if ($success -ne $true) {
    $($task.LastErrorText)

    exit
}

#  The application is now free to do anything else
#  while the email is being sent.

#  For this example, we'll simply sleep and periodically
#  check to see if the SendEmail if finished.  While checking
#  however, we'll report on the progress.
$curPctDone = 0
while ($task.Finished -ne $true) {

    if ($task.PercentDone -ne $curPctDone) {
        $curPctDone = $task.PercentDone
        $([string]$curPctDone + " percent done")
    }

    #  Sleep 100 ms.
    $task.SleepMs(100)

}

#  A finished task could be one that was canceled, aborted, or truly finished.

#  If the task was "canceled", it was canceled prior to actually starting.  This could
#  happen if the task was canceled while waiting in a thread pool queue to be scheduled by Chilkat's
#  background thread pool scheduler.

#  If the task was "aborted", it indicates that it was canceled while running in a background thread.
#  The ResultErrorText will likely indicate that the task was aborted.

#  If the task "completed", then it ran to completion, but the actual success/failure of the method
#  is determined by the result obtained via a GetResult* method.  (A "completed" task will
#  have a StatusInt equal to 7.   If the task finished, but was not completed, then it must've
#  been aborted or canceled:
if ($task.StatusInt -ne 7) {
    $("Task did not complete.")
    $("task status: " + $task.Status)

    exit
}

#  The SendEmail method returns a boolean.  Therefore, after the task is finished,
#  we can get the boolean result by calling GetResultBool.  This is the return value had
#  we called SendEmail synchronously.
$success = $task.GetResultBool()
if ($success -ne $true) {
    #  The task's ResultErrorText contains what would have been in the LastErrorText property had
    #  the SendEmail method been called synchronously.
    $($task.ResultErrorText)
}
else {
    $("Email sent asynchronously.")
}

$success = $mailman.CloseSmtpConnection()
if ($success -ne $true) {
    $("Connection to SMTP server not closed cleanly.")

}


 

© 2000-2016 Chilkat Software, Inc. All Rights Reserved.