win 0.1.11 → 0.1.13

data/VERSION

@@ -1 +1 @@
-0.1.11
+0.1.13

data/lib/win/dde.rb

@@ -62,6 +62,36 @@ module Win
     XTYP_MASK            = 0x00F0
     XTYP_SHIFT           = 0x0004
 
+    # Types Hash {TRANSACTION_TYPE=>'Type description')}
+    TYPES = {
+            XTYPF_NOBLOCK       => 'XTYPF_NOBLOCK',
+            XTYPF_NODATA        => 'XTYPF_NODATA',
+            XTYPF_ACKREQ        => 'XTYPF_ACKREQ',
+            XCLASS_MASK         => 'XCLASS_MASK',
+            XCLASS_BOOL         => 'XCLASS_BOOL',
+            XCLASS_DATA         => 'XCLASS_DATA',
+            XCLASS_FLAGS        => 'XCLASS_FLAGS',
+            XCLASS_NOTIFICATION => 'XCLASS_NOTIFICATION',
+            XTYP_ERROR          => 'XTYP_ERROR',
+            XTYP_ADVDATA        => 'XTYP_ADVDATA',
+            XTYP_ADVREQ         => 'XTYP_ADVREQ',
+            XTYP_ADVSTART       => 'XTYP_ADVSTART',
+            XTYP_ADVSTOP        => 'XTYP_ADVSTOP',
+            XTYP_EXECUTE        => 'XTYP_EXECUTE',
+            XTYP_CONNECT        => 'XTYP_CONNECT',
+            XTYP_CONNECT_CONFIRM=> 'XTYP_CONNECT_CONFIRM',
+            XTYP_XACT_COMPLETE  => 'XTYP_XACT_COMPLETE',
+            XTYP_POKE           => 'XTYP_POKE',
+            XTYP_REGISTER       => 'XTYP_REGISTER',
+            XTYP_REQUEST        => 'XTYP_REQUEST',
+            XTYP_DISCONNECT     => 'XTYP_DISCONNECT',
+            XTYP_UNREGISTER     => 'XTYP_UNREGISTER',
+            XTYP_WILDCONNECT    => 'XTYP_WILDCONNECT',
+            XTYP_MONITOR        => 'XTYP_MONITOR',
+            XTYP_MASK           => 'XTYP_MASK',
+            XTYP_SHIFT          => 'XTYP_SHIFT'
+    }
+
     # Transaction confirmations:
 
     # Transaction confirmation
@@ -147,6 +177,36 @@ module Win
     # ?
     MF_MASK                   = 0xFF000000
 
+    # Flags Hash {FLAG=>'Flag description')}
+    FLAGS = {
+            APPCLASS_STANDARD         => 'APPCLASS_STANDARD',
+            APPCLASS_MONITOR          => 'APPCLASS_MONITOR',
+            APPCLASS_MASK             => 'APPCLASS_MASK',
+            APPCMD_CLIENTONLY         => 'APPCMD_CLIENTONLY',
+            APPCMD_FILTERINITS        => 'APPCMD_FILTERINITS',
+            APPCMD_MASK               => 'APPCMD_MASK',
+            CBF_FAIL_SELFCONNECTIONS  => 'CBF_FAIL_SELFCONNECTIONS',
+            CBF_FAIL_CONNECTIONS      => 'CBF_FAIL_CONNECTIONS',
+            CBF_FAIL_ADVISES          => 'CBF_FAIL_ADVISES',
+            CBF_FAIL_EXECUTES         => 'CBF_FAIL_EXECUTES',
+            CBF_FAIL_POKES            => 'CBF_FAIL_POKES',
+            CBF_FAIL_REQUESTS         => 'CBF_FAIL_REQUESTS',
+            CBF_FAIL_ALLSVRXACTIONS   => 'CBF_FAIL_ALLSVRXACTIONS',
+            CBF_SKIP_CONNECT_CONFIRMS => 'CBF_SKIP_CONNECT_CONFIRMS',
+            CBF_SKIP_REGISTRATIONS    => 'CBF_SKIP_REGISTRATIONS',
+            CBF_SKIP_UNREGISTRATIONS  => 'CBF_SKIP_UNREGISTRATIONS',
+            CBF_SKIP_DISCONNECTS      => 'CBF_SKIP_DISCONNECTS',
+            CBF_SKIP_ALLNOTIFICATIONS => 'CBF_SKIP_ALLNOTIFICATIONS',
+            MF_HSZ_INFO               => 'MF_HSZ_INFO',
+            MF_SENDMSGS               => 'MF_SENDMSGS',
+            MF_POSTMSGS               => 'MF_POSTMSGS',
+            MF_CALLBACKS              => 'MF_CALLBACKS',
+            MF_ERRORS                 => 'MF_ERRORS',
+            MF_LINKS                  => 'MF_LINKS',
+            MF_CONV                   => 'MF_CONV',
+            MF_MASK                   => 'MF_MASK'
+    }
+
     # Error codes:
 
     # Returned if DDE Init successful
@@ -176,32 +236,36 @@ module Win
     # - The application used a freed data handle or string handle.
     # - More than one instance of the application used the same object.
     DMLERR_INVALIDPARAMETER   = 0x4006
-    #  DMLERR_LOW_MEMORY A DDEML application has created a prolonged race condition (in which the server application outruns the client), causing large amounts of memory to be consumed.
+    # A DDEML application has created a prolonged race condition (in which the server application
+    # outruns the client), causing large amounts of memory to be consumed.
     DMLERR_LOW_MEMORY    = 0x4007
-    #  DMLERR_MEMORY_ERROR A memory allocation has failed.
+    # A memory allocation has failed.
     DMLERR_MEMORY_ERROR    = 0x4008
-    #  DMLERR_NOTPROCESSED A transaction has failed.
+    # A transaction has failed.
     DMLERR_NOTPROCESSED    = 0x4009
-    #  DMLERR_NO_CONV_ESTABLISHED A client's attempt to establish a conversation has failed.
+    # A client's attempt to establish a conversation has failed.
     DMLERR_NO_CONV_ESTABLISHED    = 0x400a
-    #  DMLERR_POKEACKTIMEOUT A request for a synchronous poke transaction has timed out.
+    # A request for a synchronous poke transaction has timed out.
     DMLERR_POKEACKTIMEOUT    = 0x400b
-    #  DMLERR_POSTMSG_FAILED An internal call to the PostMessage function has failed.
+    # An internal call to the PostMessage function has failed.
     DMLERR_POSTMSG_FAILED    = 0x400c
-    #  DMLERR_REENTRANCY An application instance with a synchronous transaction already in progress attempted to initiate another synchronous transaction, or the DdeEnableCallback function was called from within a DDEML callback function.
+    # An application instance with a synchronous transaction already in progress attempted to initiate another
+    # synchronous transaction, or the DdeEnableCallback function was called from within a DDEML callback function.
     DMLERR_REENTRANCY    = 0x400d
-    #  DMLERR_SERVER_DIED A server-side transaction was attempted on a conversation terminated by the client, or the server terminated before completing a transaction.
+    # A server-side transaction was attempted on a conversation terminated by the client, or the server terminated
+    # before completing a transaction.
     DMLERR_SERVER_DIED    = 0x400e
-    # DMLERR_SYS_ERROR An internal error has occurred in the DDEML.
+    # An internal error has occurred in the DDEML.
     DMLERR_SYS_ERROR    = 0x400f
-    #  DMLERR_UNADVACKTIMEOUT A request to end an advise transaction has timed out.
+    # A request to end an advise transaction has timed out.
     DMLERR_UNADVACKTIMEOUT    = 0x4010
-    #  DMLERR_UNFOUND_QUEUE_ID An invalid transaction identifier was passed to a DDEML function. Once the application has returned from an XTYP_XACT_COMPLETE callback, the transaction identifier for that callback function is no longer valid.
+    # An invalid transaction identifier was passed to a DDEML function. Once the application has returned from an
+    # XTYP_XACT_COMPLETE callback, the transaction identifier for that callback function is no longer valid.
     DMLERR_UNFOUND_QUEUE_ID = 0x4011
     # Last (highest) error code
     DMLERR_LAST          = DMLERR_UNFOUND_QUEUE_ID
 
-    # Hash {ERROR_CODE=>'Error description')}
+    # Errors Hash {ERROR_CODE=>'Error description')}
     ERRORS = {
             DMLERR_ADVACKTIMEOUT => 'A request for a synchronous advise transaction has timed out.',
             DMLERR_BUSY => 'The response to the transaction caused the DDE_FBUSY flag to be set.',
@@ -643,7 +707,7 @@ module Win
     #              - DMLERR_NO_CONV_ESTABLISHED
     #              - DMLERR_NO_ERROR
     # ---
-    # <b> Enhanced (snake_case) API makes all args optional except for first (dde instance id), and returns nil if
+    # <b>Enhanced (snake_case) API makes all args optional except for first (dde instance id), and returns nil if
     # the function was unsuccessful.</b>
     # ---
     # *Remarks*
@@ -656,12 +720,39 @@ module Win
     #   whether the ANSI or Unicode version of the DdeInitialize function was called by the client application.
     #
     # :call-seq:
-    #  conversation_handle = dde_connect( instance_id, [service = nil, topic = nil, context = nil] )
+    #  conversation_handle = dde_connect( instance_id, [service = 0, topic = 0, context = nil] )
     #
     function :DdeConnect, [:uint32, :ulong, :ulong, :pointer], :ulong, zeronil: true,
-             &->(api, instance_id, service = nil, topic = nil, context = nil){
+             &->(api, instance_id, service = 0, topic = 0, context = nil){
              api.call(instance_id, service, topic, context) }
 
+    ##
+    # The DdeDisconnect function terminates a conversation started by either the DdeConnect or DdeConnectList function
+    # and invalidates the specified conversation handle.
+    #
+    # [*Syntax*] BOOL DdeDisconnect( HCONV hConv );
+    #
+    # hConv:: [in, out] Handle to the active conversation to be terminated.
+    #
+    # *Returns*:: If the function succeeds, the return value is nonzero, otherwise zero. The DdeGetLastError function
+    #             can be used to get the error code, which can be one of the following values:
+    #             - DMLERR_DLL_NOT_INITIALIZED
+    #             - DMLERR_NO_CONV_ESTABLISHED
+    #             - DMLERR_NO_ERROR
+    # ---
+    # <b>Enhanced (snake_case) API returns *true/false* instead of nonzero/zero.</b>
+    # ---
+    # *Remarks*:
+    # Any incomplete transactions started before calling DdeDisconnect are immediately abandoned. The XTYP_DISCONNECT
+    # transaction is sent to the Dynamic Data Exchange (DDE) callback function of the partner in the conversation.
+    # Generally, only client applications must terminate conversations.
+    #
+    # :call-seq:
+    #  success = dde_disconnect(conversation_handle)
+    #
+    function :DdeDisconnect, [:ulong], :int, boolean: true
+
+
     ##
     # The DdeGetLastError function retrieves the most recent error code set by the failure of a Dynamic Data Exchange
     # Management Library (DDEML) function and resets the error code to DMLERR_NO_ERROR.
@@ -674,6 +765,9 @@ module Win
     # DMLERR_ADVACKTIMEOUT, DMLERR_EXECACKTIMEOUT, DMLERR_INVALIDPARAMETER, DMLERR_LOW_MEMORY, DMLERR_MEMORY_ERROR,
     # DMLERR_NO_CONV_ESTABLISHED, DMLERR_NOTPROCESSED, DMLERR_POKEACKTIMEOUT, DMLERR_POSTMSG_FAILED, DMLERR_REENTRANCY,
     # DMLERR_SERVER_DIED, DMLERR_SYS_ERROR, DMLERR_UNADVACKTIMEOUT, DMLERR_UNFOUND_QUEUE_ID
+    # ---
+    # <b>Enhanced (snake_case) API returns *nil* if the function was unsuccessful (that is, no DDE errors raised).</b>
+    # ---
     #
     # :call-seq:
     #  string = dde_get_last_error( instance_id )

data/spec/win/dde_spec.rb

@@ -231,9 +231,17 @@ module WinDDETest
       end
 
       describe '#dde_connect' do
-        it 'connects to existing DDE server'
+        spec{ use{ conversation_handle = DdeConnect( instance_id=0, service=0, topic=0, context=nil) }}
+        spec{ use{ conversation_handle = dde_connect( instance_id=0, service=0, topic=0, context=nil) }}
+          it 'connects to existing DDE server'
       end
 
+      describe '#dde_disconnect' do
+        spec{ use{ success = DdeDisconnect(conversation_handle=0) }}
+        spec{ use{ success = dde_disconnect(conversation_handle=0) }}
+
+        it 'disconnects from existing DDE server'
+      end
     end
   end
 end

data/win.gemspec

@@ -5,7 +5,7 @@
 
 Gem::Specification.new do |s|
   s.name = %q{win}
-  s.version = "0.1.11"
+  s.version = "0.1.13"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["arvicco"]

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: win
 version: !ruby/object:Gem::Version 
-  version: 0.1.11
+  version: 0.1.13
 platform: ruby
 authors: 
 - arvicco