SQL Server

Transition from Zip.AppendString2 to Zip.AddString

Provides instructions for replacing deprecated AppendString2 method calls with AddString. SQL Server

-- 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)
    DECLARE @success int
    SELECT @success = 0

    DECLARE @zip int
    EXEC @hr = sp_OACreate 'Chilkat.Zip', @zip OUT
    IF @hr <> 0
    BEGIN
        PRINT 'Failed to create ActiveX component'
        RETURN
    END

    -- ...
    -- ...
    DECLARE @pathInZip nvarchar(4000)
    SELECT @pathInZip = 'example.txt'
    DECLARE @textData nvarchar(4000)
    SELECT @textData = 'This is a test'
    DECLARE @charset nvarchar(4000)
    SELECT @charset = 'utf-8'

    -- ------------------------------------------------------------------------
    -- The AppendString method is deprecated:

    DECLARE @entryObj int
    EXEC sp_OAMethod @zip, 'AppendString2', @entryObj OUT, @pathInZip, @textData, @charset
    EXEC sp_OAGetProperty @zip, 'LastMethodSuccess', @iTmp0 OUT
    IF @iTmp0 = 0
      BEGIN
        EXEC sp_OAGetProperty @zip, 'LastErrorText', @sTmp0 OUT
        PRINT @sTmp0
        EXEC @hr = sp_OADestroy @zip
        RETURN
      END

    -- ...
    -- ...

    EXEC @hr = sp_OADestroy @entryObj

    -- ------------------------------------------------------------------------
    -- Do the equivalent using AddString.

    -- Instead of returning the zip entry object, we just return success/failure.
    EXEC sp_OAMethod @zip, 'AddString', @success OUT, @pathInZip, @textData, @charset
    IF @success = 0
      BEGIN
        EXEC sp_OAGetProperty @zip, 'LastErrorText', @sTmp0 OUT
        PRINT @sTmp0
        EXEC @hr = sp_OADestroy @zip
        RETURN
      END

    -- Do the following if you need the zip entry object for what was just appended.
    -- The newly appended entry is the last one.
    DECLARE @ze int
    EXEC @hr = sp_OACreate 'Chilkat.ZipEntry', @ze OUT

    DECLARE @index int
    EXEC sp_OAGetProperty @zip, 'NumEntries', @iTmp0 OUT
    SELECT @index = @iTmp0 - 1
    EXEC sp_OAMethod @zip, 'EntryAt', @success OUT, @index, @ze

    EXEC @hr = sp_OADestroy @zip
    EXEC @hr = sp_OADestroy @ze


END
GO