Difference between revisions of "RPC HELP DLL ExportFN RPCBPropGet"

From VistApedia
Jump to: navigation, search
Line 3: Line 3:
 
[[RPC_HELP_Other_DLL_Interface_List|DLL Interface Home]]
 
[[RPC_HELP_Other_DLL_Interface_List|DLL Interface Home]]
 
<h2>RPCBPropGet Function</h2>
 
<h2>RPCBPropGet Function</h2>
Examples
 
 
 
[[RPC_HELP_DLL_ExportFN_RPCBPropGet_Example|Example]]
 
[[RPC_HELP_DLL_ExportFN_RPCBPropGet_Example|Example]]
  
Returns a requested property of a TRPCBroker component.
+
Returns a requested property of a [[RPC_HELP_TRPCBroker|TRPCBroker]] component.
 
 
 
Declarations
 
Delphi procedure RPCBPropGet(const RPCBroker: TRPCBroker; const Prop: PChar; {var} Value: PChar);
 
C void (__stdcall *RPCBPropGet) (void *, char *, char *);
 
C++ void RPCBPropGet ( char * s, char * t);
 
VB Sub RPCBPropGet (ByVal intRPCBHandle As Long, ByVal strProp As String, ByVal strValue As String)
 
 
 
 +
<h3>Declarations</h3>
 +
    Delphi -- procedure RPCBPropGet(const RPCBroker: TRPCBroker; const Prop: PChar; {var} Value: PChar);
 +
    C -- void (__stdcall *RPCBPropGet) (void *, char *, char *);
 +
    C++ -- void RPCBPropGet ( char * s, char * t);
 +
    VB -- Sub RPCBPropGet (ByVal intRPCBHandle As Long, ByVal strProp As String, ByVal strValue As String)
  
Parameter Description
+
<h3>Parameter Description</h3>
RPCBroker Handle of the TRPCBroker component.
+
* '''RPCBroker''' Handle of the [[RPC_HELP_TRPCBroker|TRPCBroker]] component.
Prop Null-terminated string of the property to get. Not case-sensitive. Valid properties to get are: ClearParameters, ClearResults, Connected, DebugMode, ListenerPort, RemoteProcedure, RPCTimeLimit, RPCVersion, and Server.
+
* '''Prop''' Null-terminated string of the property to get. Not case-sensitive. Valid properties to get are: * [[RPC_HELP_TRPCBroker_ClearParameters|ClearParameters]], [[RPC_HELP_TRPCBroker_ClearResults|ClearResults]], [[RPC_HELP_TRPCBroker_Connected|Connected]], [[RPC_HELP_TRPCBroker_DebugMode|DebugMode]], [[RPC_HELP_TRPCBroker_ListenerPort|ListenerPort]], [[RPC_HELP_TRPCBroker_RemoteProcedure|RemoteProcedure]], [[RPC_HELP_TRPCBroker_RPCTimeLimit|RPCTimeLimit]], [[RPC_HELP_TRPCBroker_RPCVersion|RPCVersion]], and [[RPC_HELP_TRPCBroker_Server|Server]].
Value An empty buffer that you must create (allocate memory for) before making this call. After this call, the buffer is filled with value of the property that is in the Prop. This procedure takes care of all the necessary type conversions. Boolean property values are returned as 1 (True) or 0 (False).
+
* '''Value''' An empty buffer that you must create (allocate memory for) before making this call. After this call, the buffer is filled with value of the property that is in the Prop. This procedure takes care of all the necessary type conversions. Boolean property values are returned as 1 (True) or 0 (False).

Revision as of 15:00, 8 July 2015

RPC Broker Help Home

DLL Interface Home

RPCBPropGet Function

Example

Returns a requested property of a TRPCBroker component.

Declarations

   Delphi -- procedure RPCBPropGet(const RPCBroker: TRPCBroker; const Prop: PChar; {var} Value: PChar);
   C -- void (__stdcall *RPCBPropGet) (void *, char *, char *);
   C++ -- void RPCBPropGet ( char * s, char * t);
   VB -- Sub RPCBPropGet (ByVal intRPCBHandle As Long, ByVal strProp As String, ByVal strValue As String)

Parameter Description

  • RPCBroker Handle of the TRPCBroker component.
  • Prop Null-terminated string of the property to get. Not case-sensitive. Valid properties to get are: * ClearParameters, ClearResults, Connected, DebugMode, ListenerPort, RemoteProcedure, RPCTimeLimit, RPCVersion, and Server.
  • Value An empty buffer that you must create (allocate memory for) before making this call. After this call, the buffer is filled with value of the property that is in the Prop. This procedure takes care of all the necessary type conversions. Boolean property values are returned as 1 (True) or 0 (False).