WinRestartWPDServer: Difference between revisions

Revision as of 19:28, 8 December 2016

actionFlag - BOOL - input: Flag indicating the state to put the Workplace Shell DSOM Server into.

Flag for the action to do:

This function returns a APIRET with the values of:

INCL_WPCLASS

...
BOOL fAction;
BOOL rc;
...
rc = WinRestartWPDServer (fAction);
...

The PM Shell must be up and running.

The DSOM daemon must be up and running, before the Workplace Shell DSOM Server can be started.

@@ Line 1: / Line 1: @@
-#REDIRECT [[OS2 API:PMI:WinRestartWPDServer]]
+== WinRestartWPDServer ==
+; WinRestartWPDServer(actionFlag) : Restart the Workplace Shell [[DSOM]] Server.
+=== Parameters ===
+; actionFlag - [[BOOL]] - input : Flag indicating the state to put the Workplace Shell DSOM Server into.
+=== Constants ===
+Flag for the action to do:
+;[[TRUE]] : Start the Workplace Shell DSOM Server.
+;[[FALSE]] : Stop the Workplace Shell DSOM Server.
+=== Returns ===
+This function returns a [[APIRET]] with the values of:
+* [[OS2_API:PMI:error#PMERR_OK|PMERR_OK]]
+* [[OS2_API:PMI:error#PMERR_WPDSERVER_IS_ACTIVE|PMERR_WPDSERVER_IS_ACTIVE]]
+* [[OS2_API:PMI:error#PMERR_WPDSERVER_NOT_STARTED|PMERR_WPDSERVER_NOT_STARTED]]
+=== Define (C/C++) ===
+INCL_WPCLASS
+=== Calling conversion ===
+[[Cdecl32]]
+=== Example Code ===
+ ...
+ BOOL fAction;
+ BOOL rc;
+ ...
+ rc = WinRestartWPDServer (fAction);
+ ...
+=== Related Functions ===
+*[[WinIsSOMDDReady]]
+*[[WinIsWPDServerReady]]
+*[[WinRestartSOMDD]]
+=== Notes ===
+The PM Shell must be up and running.
+The DSOM daemon must be up and running, before the Workplace Shell [[DSOM]] Server can be started.
+[[Category:Win]]