(SQL Server) Get the LastErrorText for an Asynchronous Method Call

See more Async Examples

Demonstrates how to get the LastErrorText information for a Chilkat method called asynchronously.

Chilkat ActiveX Downloads ActiveX for 32-bit and 64-bit Windows

-- Important: See this note about string length limitations for strings returned by sp_OAMethod calls.
--
CREATE PROCEDURE ChilkatSample
AS
BEGIN
    DECLARE @hr int
    DECLARE @iTmp0 int
    -- Important: Do not use nvarchar(max).  See the warning about using nvarchar(max).
    DECLARE @sTmp0 nvarchar(4000)
    -- This example requires the Chilkat API to have been previously unlocked.
    -- See Global Unlock Sample for sample code.

    DECLARE @socket int
    -- Use "Chilkat_9_5_0.Socket" for versions of Chilkat < 10.0.0
    EXEC @hr = sp_OACreate 'Chilkat.Socket', @socket OUT
    IF @hr <> 0
    BEGIN
        PRINT 'Failed to create ActiveX component'
        RETURN
    END

    -- The Async call simply creates the task.  The "Connect" method has not yet been called.
    DECLARE @maxWaitMs int
    SELECT @maxWaitMs = 5000
    -- Let's intentionally cause this connect to fail by giving it an invalid domain..
    DECLARE @task int
    EXEC sp_OAMethod @socket, 'ConnectAsync', @task OUT, 'amazonbladflakjsdflksadjf.com', 443, 1, @maxWaitMs
    EXEC sp_OAGetProperty @socket, 'LastMethodSuccess', @iTmp0 OUT
    IF @iTmp0 = 0
      BEGIN
        EXEC sp_OAGetProperty @socket, 'LastErrorText', @sTmp0 OUT
        PRINT @sTmp0
        EXEC @hr = sp_OADestroy @socket
        RETURN
      END
    -- Start the background thread to run the task.
    DECLARE @success int
    EXEC sp_OAMethod @task, 'Run', @success OUT
    IF Not @success
      BEGIN
        EXEC sp_OAGetProperty @task, 'LastErrorText', @sTmp0 OUT
        PRINT @sTmp0
        EXEC @hr = sp_OADestroy @task

        EXEC @hr = sp_OADestroy @socket
        RETURN
      END

    -- The application is now free to do anything else

    -- For this example, we'll simply sleep and periodically
    -- check to see if the Socket Connect if finished.
    EXEC sp_OAGetProperty @task, 'Finished', @iTmp0 OUT
    WHILE @iTmp0 <> 1
      BEGIN
        -- Sleep 1 ms.
        EXEC sp_OAMethod @task, 'SleepMs', NULL, 1
      END

    -- If the task completed, it means the method (in this case the Connect method) was called and returned success or failure.
    EXEC sp_OAGetProperty @task, 'StatusInt', @iTmp0 OUT
    IF @iTmp0 <> 7
      BEGIN

        PRINT 'Task did not complete.'

        EXEC sp_OAGetProperty @task, 'Status', @sTmp0 OUT
        PRINT 'task status: ' + @sTmp0
        EXEC @hr = sp_OADestroy @task

        EXEC @hr = sp_OADestroy @socket
        RETURN
      END

    -- Get the success/failure of the Connect
    -- (This is the return value of the Connect method had it been called synchronously)
    EXEC sp_OAMethod @task, 'GetResultBool', @success OUT
    IF @success = 0
      BEGIN
        -- Get the LastErrorText for the Connect method call.
        -- Had we called Connect synchronously, we would've simply accessed the socket object's LastErrorText property.
        -- Instead, we get the task object's ResultErrorText.
        EXEC sp_OAGetProperty @task, 'ResultErrorText', @sTmp0 OUT
        PRINT @sTmp0
      END
    ELSE
      BEGIN

        PRINT 'Connect succeeded.'
      END

    EXEC @hr = sp_OADestroy @task


    EXEC @hr = sp_OADestroy @socket


END
GO