Chilkat Examples

ChilkatHOMEAndroid™Classic ASPCC++C#Mono C#.NET Core C#C# UWP/WinRTDataFlexDelphi ActiveXDelphi DLLVisual FoxProJavaLianjaMFCObjective-CPerlPHP ActiveXPHP ExtensionPowerBuilderPowerShellPureBasicCkPythonChilkat2-PythonRubySQL ServerSwift 2Swift 3/4TclUnicode CUnicode C++Visual Basic 6.0VB.NETVB.NET UWP/WinRTVBScriptXojo PluginNode.jsExcelGo

C Examples

Web API Categories

ASN.1
Amazon Glacier
Amazon S3
Amazon S3 (new)
Amazon SES
Amazon SNS
Amazon SQS
Async
Azure Cloud Storage
Azure Service Bus
Base64
Bounced Email
Box
CSR
CSV
Certificates
Compression
DKIM / DomainKey
DSA
Diffie-Hellman
Digital Signatures
Dropbox
Dynamics CRM
ECC
Email Object
Encryption
FTP
FileAccess
Firebase
GMail REST API
Google APIs
Google Calendar
Google Cloud Storage
Google Drive
Google Photos
Google Sheets
Google Tasks
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
REST
REST Misc
RSA Encryption
SCP
SFTP
SMTP
SSH
SSH Key
SSH Tunnel
SharePoint
Socket/SSL/TLS
Spider
Stream
Tar Archive
Upload
WebSocket
XAdES
XML
XML Digital Signatures
XMP
Zip
curl

 

 

 

(C) Async Methods Returning an Object

Demonstrates how to call an asynchronous method that returns an object. This example reads email from a POP3 server using the Async versions of the Chilkat methods.

Chilkat C/C++ Library Downloads

MS Visual C/C++

Linux/CentOS C/C++

Alpine Linux C/C++

MAC OS X C/C++

armhf/aarch64 C/C++

C++ Builder

iOS C/C++

Android C/C++

Win Mobile 5.0/Pocket PC 2003

Solaris C/C++

FreeBSD C/C++

OpenBSD C/C++

MinGW C/C++

#include <C_CkGlobal.h>
#include <C_CkMailMan.h>
#include <C_CkTask.h>
#include <C_CkEmail.h>

void ChilkatSample(void)
    {
    HCkGlobal chilkatGlob;
    BOOL success;
    HCkMailMan mailman;
    HCkTask task;
    int maxWaitMs;
    int numMessages;
    HCkEmail email;
    int i;

    // All Chilkat classes can be unlocked at once at the beginning of a program
    // by calling UnlockBundle.  It requires a Bundle unlock code.
    chilkatGlob = CkGlobal_Create();
    success = CkGlobal_UnlockBundle(chilkatGlob,"Anything for 30-day trial.");
    if (success != TRUE) {
        printf("%s\n",CkGlobal_lastErrorText(chilkatGlob));
        CkGlobal_Dispose(chilkatGlob);
        return;
    }

    mailman = CkMailMan_Create();

    // Set the POP3 server's hostname
    CkMailMan_putMailHost(mailman,"pop.someMailServer.com");

    // Set the POP3 login/password and any other requirements..
    CkMailMan_putPopUsername(mailman,"myLogin");
    CkMailMan_putPopPassword(mailman,"myPassword");
    CkMailMan_putPopSsl(mailman,TRUE);
    CkMailMan_putMailPort(mailman,995);

    // Connect to the POP3 server:
    task = CkMailMan_Pop3BeginSessionAsync(mailman);
    if (CkMailMan_getLastMethodSuccess(mailman) == FALSE) {
        printf("%s\n",CkMailMan_lastErrorText(mailman));
        CkGlobal_Dispose(chilkatGlob);
        CkMailMan_Dispose(mailman);
        return;
    }

    // Start the background task.
    success = CkTask_Run(task);
    if (!success) {
        printf("%s\n",CkTask_lastErrorText(task));
        CkTask_Dispose(task);
        CkGlobal_Dispose(chilkatGlob);
        CkMailMan_Dispose(mailman);
        return;
    }

    // Wait for the POP3 connect task to finish.
    // The TRUE/FALSE returned by Wait applies to the Wait method call, not the task.
    maxWaitMs = 30000;
    success = CkTask_Wait(task,maxWaitMs);
    if (!success || (CkTask_getStatusInt(task) != 7) || (CkTask_getTaskSuccess(task) != TRUE)) {
        if (!success) {
            // The task.LastErrorText applies to the Wait method call.
            printf("%s\n",CkTask_lastErrorText(task));
        }
        else {
            // The ResultErrorText applies to the underlying task method call (i.e. the Pop3BeginSession)
            printf("%s\n",CkTask_status(task));
            printf("%s\n",CkTask_resultErrorText(task));
        }

        CkTask_Dispose(task);
        CkGlobal_Dispose(chilkatGlob);
        CkMailMan_Dispose(mailman);
        return;
    }

    CkTask_Dispose(task);

    // Get the number of messages in the mailbox.
    task = CkMailMan_GetMailboxCountAsync(mailman);

    // To keep the example short, we'll skip handling failures.
    // The failures would be handled in the same way as shown above.

    success = CkTask_Run(task);
    success = CkTask_Wait(task,maxWaitMs);
    numMessages = CkTask_GetResultInt(task);
    CkTask_Dispose(task);
    if (numMessages == 0) {
        CkGlobal_Dispose(chilkatGlob);
        CkMailMan_Dispose(mailman);
        return;
    }

    email = CkEmail_Create();

    for (i = 1; i <= numMessages; i++) {

        task = CkMailMan_FetchByMsgnumAsync(mailman,i);
        if (CkMailMan_getLastMethodSuccess(mailman) == FALSE) {
            printf("%s\n",CkMailMan_lastErrorText(mailman));
            CkGlobal_Dispose(chilkatGlob);
            CkMailMan_Dispose(mailman);
            CkEmail_Dispose(email);
            return;
        }

        success = CkTask_Run(task);
        success = CkTask_Wait(task,maxWaitMs);
        if (!success || (CkTask_getStatusInt(task) != 7) || (CkTask_getTaskSuccess(task) != TRUE)) {
            if (!success) {
                // The task.LastErrorText applies to the Wait method call.
                printf("%s\n",CkTask_lastErrorText(task));
            }
            else {
                // The ResultErrorText applies to the underlying task method call (i.e. the FetchByMsgnum)
                printf("%s\n",CkTask_status(task));
                printf("%s\n",CkTask_resultErrorText(task));
            }

            CkTask_Dispose(task);
            CkGlobal_Dispose(chilkatGlob);
            CkMailMan_Dispose(mailman);
            CkEmail_Dispose(email);
            return;
        }

        // Each Chilkat object that can be a return value of an asynchronous task will
        // have a method named LoadTaskResult.  The object returned in the underlying
        // asynchronous method call is retrieved by calling LoadTaskResult. 

        // To say it another way: The application will provide a pre-existing object of
        // the desired return type (in this case it is an email object).  This object is
        // loaded by calling LoadTaskResult.  

        success = CkEmail_LoadTaskResult(email,task);
        CkTask_Dispose(task);

        if (!success) {
            printf("%s\n",CkEmail_lastErrorText(email));
            CkGlobal_Dispose(chilkatGlob);
            CkMailMan_Dispose(mailman);
            CkEmail_Dispose(email);
            return;
        }
        else {
            printf("%s: %s\n\n",CkEmail_ck_from(email),CkEmail_subject(email));
        }

    }



    CkGlobal_Dispose(chilkatGlob);
    CkMailMan_Dispose(mailman);
    CkEmail_Dispose(email);

    }

 

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