php-doc-en/reference/win32service/constants.xml
Richard Quadling 5c5c01e027 Useful constant.
git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@307765 c90b9560-bf6c-de11-be94-00142212c4b1
2011-01-26 16:19:02 +00:00

664 lines
20 KiB
XML

<?xml version='1.0' encoding="utf-8"?>
<!-- $Revision$ -->
<appendix xml:id="win32service.constants" xmlns="http://docbook.org/ns/docbook">
&reftitle.constants;
&extension.constants;
<section xml:id="win32service.constants.servicetype">
<table>
<title>Win32Service Service Type Bitmasks</title>
<tgroup cols="3">
<thead>
<row>
<entry>Constant</entry>
<entry>Value</entry>
<entry>Description</entry>
</row>
</thead>
<tbody>
<row>
<entry><constant>WIN32_SERVICE_WIN32_OWN_PROCESS</constant></entry>
<entry>0x00000010</entry>
<entry>
The service runs in its own process.
</entry>
</row>
<row>
<entry><constant>WIN32_SERVICE_INTERACTIVE_PROCESS</constant></entry>
<entry>0x00000100</entry>
<entry>
The service can interact with the desktop. This option is not available on Windows Vista or later.
</entry>
</row>
<row>
<entry><constant>WIN32_SERVICE_WIN32_OWN_PROCESS_INTERACTIVE</constant></entry>
<entry>0x00000110</entry>
<entry>
The service runs in its own process and can interact with the desktop. This option is not available on Windows Vista or later.
</entry>
</row>
</tbody>
</tgroup>
</table>
</section>
<section xml:id="win32service.constants.servicestatus">
<table>
<title>Win32Service Service Status Constants</title>
<tgroup cols="3">
<thead>
<row>
<entry>Constant</entry>
<entry>Value</entry>
<entry>Description</entry>
</row>
</thead>
<tbody>
<row>
<entry><constant>WIN32_SERVICE_CONTINUE_PENDING</constant></entry>
<entry>0x00000005</entry>
<entry>
The service continue is pending.
</entry>
</row>
<row>
<entry><constant>WIN32_SERVICE_PAUSE_PENDING</constant></entry>
<entry>0x00000006</entry>
<entry>
The service pause is pending.
</entry>
</row>
<row>
<entry><constant>WIN32_SERVICE_PAUSED</constant></entry>
<entry>0x00000007</entry>
<entry>
The service is paused.
</entry>
</row>
<row>
<entry><constant>WIN32_SERVICE_RUNNING</constant></entry>
<entry>0x00000004</entry>
<entry>
The service is running.
</entry>
</row>
<row>
<entry><constant>WIN32_SERVICE_START_PENDING</constant></entry>
<entry>0x00000002</entry>
<entry>
The service is starting.
</entry>
</row>
<row>
<entry><constant>WIN32_SERVICE_STOP_PENDING</constant></entry>
<entry>0x00000003</entry>
<entry>
The service is stopping.
</entry>
</row>
<row>
<entry><constant>WIN32_SERVICE_STOPPED</constant></entry>
<entry>0x00000001</entry>
<entry>
The service is not running.
</entry>
</row>
</tbody>
</tgroup>
</table>
</section>
<section xml:id="win32service.constants.servicecontrol">
<table>
<title>Win32Service Service Control Message Constants</title>
<tgroup cols="3">
<thead>
<row>
<entry>Constant</entry>
<entry>Value</entry>
<entry>Description</entry>
</row>
</thead>
<tbody>
<row>
<entry><constant>WIN32_SERVICE_CONTROL_CONTINUE</constant></entry>
<entry>0x00000003</entry>
<entry>
Notifies a paused service that it should resume.
</entry>
</row>
<row>
<entry><constant>WIN32_SERVICE_CONTROL_INTERROGATE</constant></entry>
<entry>0x00000004</entry>
<entry>
Notifies a service that it should report its current status information
to the service control manager.
</entry>
</row>
<row>
<entry><constant>WIN32_SERVICE_CONTROL_PAUSE</constant></entry>
<entry>0x00000002</entry>
<entry>
Notifies a service that it should pause.
</entry>
</row>
<row>
<entry><constant>WIN32_SERVICE_CONTROL_PRESHUTDOWN</constant></entry>
<entry>0x0000000F</entry>
<entry>
Notifies a service that the system will be shutting down. A service that
handles this notification blocks system shutdown until the service stops
or the preshutdown time-out interval expires. This value is not supported
by Windows Server 2003 and Windows XP/2000.
</entry>
</row>
<row>
<entry><constant>WIN32_SERVICE_CONTROL_SHUTDOWN</constant></entry>
<entry>0x00000005</entry>
<entry>
Notifies a service that the system is shutting down so the service can
perform cleanup tasks. If a service accepts this control code, it must
stop after it performs its cleanup tasks. After the SCM sends this
control code, it will not send other control codes to the service.
</entry>
</row>
<row>
<entry><constant>WIN32_SERVICE_CONTROL_STOP</constant></entry>
<entry>0x00000001</entry>
<entry>
Notifies a service that it should stop.
</entry>
</row>
</tbody>
</tgroup>
</table>
</section>
<section xml:id="win32service.constants.controlsaccepted">
<table>
<title>Win32Service Service Control Message Accepted Bitmasks</title>
<tgroup cols="3">
<thead>
<row>
<entry>Constant</entry>
<entry>Value</entry>
<entry>Description</entry>
</row>
</thead>
<tbody>
<row>
<entry><constant>WIN32_SERVICE_ACCEPT_PAUSE_CONTINUE</constant></entry>
<entry>0x00000002</entry>
<entry>
The service can be paused and continued. This control code allows the
service to receive <constant>WIN32_SERVICE_CONTROL_PAUSE</constant> and
<constant>WIN32_SERVICE_CONTROL_CONTINUE</constant> notifications.
</entry>
</row>
<row>
<entry><constant>WIN32_SERVICE_ACCEPT_PRESHUTDOWN</constant></entry>
<entry>0x00000100</entry>
<entry>
The service can perform preshutdown tasks. This control code enables the
service to receive <constant>WIN32_SERVICE_CONTROL_PRESHUTDOWN</constant>
notifications. This value is not supported by Windows Server 2003 and
Windows XP/2000.
</entry>
</row>
<row>
<entry><constant>WIN32_SERVICE_ACCEPT_SHUTDOWN</constant></entry>
<entry>0x00000004</entry>
<entry>
The service is notified when system shutdown occurs. This control code
allows the service to receive <constant>WIN32_SERVICE_CONTROL_SHUTDOWN</constant>
notifications.
</entry>
</row>
<row>
<entry><constant>WIN32_SERVICE_ACCEPT_STOP</constant></entry>
<entry>0x00000001</entry>
<entry>
The service can be stopped. This control code allows the service to
receive <constant>WIN32_SERVICE_CONTROL_STOP</constant> notifications.
</entry>
</row>
</tbody>
</tgroup>
</table>
</section>
<section xml:id="win32service.constants.servicestarttype">
<table>
<title>Win32Service Service Start Type Constants</title>
<tgroup cols="3">
<thead>
<row>
<entry>Constant</entry>
<entry>Value</entry>
<entry>Description</entry>
</row>
</thead>
<tbody>
<row>
<entry><constant>WIN32_SERVICE_AUTO_START</constant></entry>
<entry>0x00000002</entry>
<entry>
A service started automatically by the service control manager during
system startup.
</entry>
</row>
<row>
<entry><constant>WIN32_SERVICE_DEMAND_START</constant></entry>
<entry>0x00000003</entry>
<entry>
A service started by the service control manager when a process calls the
StartService function.
</entry>
</row>
<row>
<entry><constant>WIN32_SERVICE_DISABLED</constant></entry>
<entry>0x00000004</entry>
<entry>
A service that cannot be started. Attempts to start the service result in
the error code <constant>WIN32_ERROR_SERVICE_DISABLED</constant>.
</entry>
</row>
</tbody>
</tgroup>
</table>
</section>
<section xml:id="win32service.constants.errorcontrol">
<table>
<title>Win32Service Service Error Control Constants</title>
<tgroup cols="3">
<thead>
<row>
<entry>Constant</entry>
<entry>Value</entry>
<entry>Description</entry>
</row>
</thead>
<tbody>
<row>
<entry><constant>WIN32_SERVICE_ERROR_IGNORE</constant></entry>
<entry>0x00000000</entry>
<entry>
The startup program ignores the error and continues the startup operation.
</entry>
</row>
<row>
<entry><constant>WIN32_SERVICE_ERROR_NORMAL</constant></entry>
<entry>0x00000001</entry>
<entry>
The startup program logs the error in the event log but continues the
startup operation.
</entry>
</row>
</tbody>
</tgroup>
</table>
</section>
<section xml:id="win32service.constants.serviceflag">
<table>
<title>Win32Service Service Flag Constants</title>
<tgroup cols="3">
<thead>
<row>
<entry>Constant</entry>
<entry>Value</entry>
<entry>Description</entry>
</row>
</thead>
<tbody>
<row>
<entry><constant>WIN32_SERVICE_RUNS_IN_SYSTEM_PROCESS</constant></entry>
<entry>0x00000001</entry>
<entry>
The service runs in a system process that must always be running.
</entry>
</row>
</tbody>
</tgroup>
</table>
</section>
<section xml:id="win32service.constants.errors">
<table>
<title>Win32 Error Codes</title>
<tgroup cols="3">
<thead>
<row>
<entry>Constant</entry>
<entry>Value</entry>
<entry>Description</entry>
</row>
</thead>
<tbody>
<row>
<entry><constant>WIN32_ERROR_ACCESS_DENIED</constant></entry>
<entry>0x00000005</entry>
<entry>
The handle to the SCM database does not have the appropriate access rights.
</entry>
</row>
<row>
<entry><constant>WIN32_ERROR_CIRCULAR_DEPENDENCY</constant></entry>
<entry>0x00000423</entry>
<entry>
A circular service dependency was specified.
</entry>
</row>
<row>
<entry><constant>WIN32_ERROR_DATABASE_DOES_NOT_EXIST</constant></entry>
<entry>0x00000429</entry>
<entry>
The specified database does not exist.
</entry>
</row>
<row>
<entry><constant>WIN32_ERROR_DEPENDENT_SERVICES_RUNNING</constant></entry>
<entry>0x0000041B</entry>
<entry>
The service cannot be stopped because other running services are dependent
on it.
</entry>
</row>
<row>
<entry><constant>WIN32_ERROR_DUPLICATE_SERVICE_NAME</constant></entry>
<entry>0x00000436</entry>
<entry>
The display name already exists in the service control manager database
either as a service name or as another display name.
</entry>
</row>
<row>
<entry><constant>WIN32_ERROR_FAILED_SERVICE_CONTROLLER_CONNECT</constant></entry>
<entry>0x00000427</entry>
<entry>
This error is returned if the program is being run as a console application
rather than as a service. If the program will be run as a console application
for debugging purposes, structure it such that service-specific code is not
called.
</entry>
</row>
<row>
<entry><constant>WIN32_ERROR_INSUFFICIENT_BUFFER</constant></entry>
<entry>0x0000007A</entry>
<entry>
The buffer is too small for the service status structure. Nothing was
written to the structure.
</entry>
</row>
<row>
<entry><constant>WIN32_ERROR_INVALID_DATA</constant></entry>
<entry>0x0000000D</entry>
<entry>
The specified service status structure is invalid.
</entry>
</row>
<row>
<entry><constant>WIN32_ERROR_INVALID_HANDLE</constant></entry>
<entry>0x00000006</entry>
<entry>
The handle to the specified service control manager database is invalid.
</entry>
</row>
<row>
<entry><constant>WIN32_ERROR_INVALID_LEVEL</constant></entry>
<entry>0x0000007C</entry>
<entry>
The InfoLevel parameter contains an unsupported value.
</entry>
</row>
<row>
<entry><constant>WIN32_ERROR_INVALID_NAME</constant></entry>
<entry>0x0000007B</entry>
<entry>
The specified service name is invalid.
</entry>
</row>
<row>
<entry><constant>WIN32_ERROR_INVALID_PARAMETER</constant></entry>
<entry>0x00000057</entry>
<entry>
A parameter that was specified is invalid.
</entry>
</row>
<row>
<entry><constant>WIN32_ERROR_INVALID_SERVICE_ACCOUNT</constant></entry>
<entry>0x00000421</entry>
<entry>
The user account name specified in the <parameter>user</parameter>
parameter does not exist. See <function>win32_create_service</function>.
</entry>
</row>
<row>
<entry><constant>WIN32_ERROR_INVALID_SERVICE_CONTROL</constant></entry>
<entry>0x0000041C</entry>
<entry>
The requested control code is not valid, or it is unacceptable to the service.
</entry>
</row>
<row>
<entry><constant>WIN32_ERROR_PATH_NOT_FOUND</constant></entry>
<entry>0x00000003</entry>
<entry>
The service binary file could not be found.
</entry>
</row>
<row>
<entry><constant>WIN32_ERROR_SERVICE_ALREADY_RUNNING</constant></entry>
<entry>0x00000420</entry>
<entry>
An instance of the service is already running.
</entry>
</row>
<row>
<entry><constant>WIN32_ERROR_SERVICE_CANNOT_ACCEPT_CTRL</constant></entry>
<entry>0x00000425</entry>
<entry>
The requested control code cannot be sent to the service because the state
of the service is <constant>WIN32_SERVICE_STOPPED</constant>,
<constant>WIN32_SERVICE_START_PENDING</constant>, or
<constant>WIN32_SERVICE_STOP_PENDING</constant>.
</entry>
</row>
<row>
<entry><constant>WIN32_ERROR_SERVICE_DATABASE_LOCKED</constant></entry>
<entry>0x0000041F</entry>
<entry>
The database is locked.
</entry>
</row>
<row>
<entry><constant>WIN32_ERROR_SERVICE_DEPENDENCY_DELETED</constant></entry>
<entry>0x00000433</entry>
<entry>
The service depends on a service that does not exist or has been marked
for deletion.
</entry>
</row>
<row>
<entry><constant>WIN32_ERROR_SERVICE_DEPENDENCY_FAIL</constant></entry>
<entry>0x0000042C</entry>
<entry>
The service depends on another service that has failed to start.
</entry>
</row>
<row>
<entry><constant>WIN32_ERROR_SERVICE_DISABLED</constant></entry>
<entry>0x00000422</entry>
<entry>
The service has been disabled.
</entry>
</row>
<row>
<entry><constant>WIN32_ERROR_SERVICE_DOES_NOT_EXIST</constant></entry>
<entry>0x00000424</entry>
<entry>
The specified service does not exist as an installed service.
</entry>
</row>
<row>
<entry><constant>WIN32_ERROR_SERVICE_EXISTS</constant></entry>
<entry>0x00000431</entry>
<entry>
The specified service already exists in this database.
</entry>
</row>
<row>
<entry><constant>WIN32_ERROR_SERVICE_LOGON_FAILED</constant></entry>
<entry>0x0000042D</entry>
<entry>
The service did not start due to a logon failure. This error occurs if
the service is configured to run under an account that does not have the
"Log on as a service" right.
</entry>
</row>
<row>
<entry><constant>WIN32_ERROR_SERVICE_MARKED_FOR_DELETE</constant></entry>
<entry>0x00000430</entry>
<entry>
The specified service has already been marked for deletion.
</entry>
</row>
<row>
<entry><constant>WIN32_ERROR_SERVICE_NO_THREAD</constant></entry>
<entry>0x0000041E</entry>
<entry>
A thread could not be created for the service.
</entry>
</row>
<row>
<entry><constant>WIN32_ERROR_SERVICE_NOT_ACTIVE</constant></entry>
<entry>0x00000426</entry>
<entry>
The service has not been started.
</entry>
</row>
<row>
<entry><constant>WIN32_ERROR_SERVICE_REQUEST_TIMEOUT</constant></entry>
<entry>0x0000041D</entry>
<entry>
The process for the service was started, but it did not call
StartServiceCtrlDispatcher, or the thread that called
StartServiceCtrlDispatcher may be blocked in a control handler function.
</entry>
</row>
<row>
<entry><constant>WIN32_ERROR_SHUTDOWN_IN_PROGRESS</constant></entry>
<entry>0x0000045B</entry>
<entry>
The system is shutting down; this function cannot be called.
</entry>
</row>
<row>
<entry><constant>WIN32_NO_ERROR</constant></entry>
<entry>0x00000000</entry>
<entry>
No error.
</entry>
</row>
</tbody>
</tgroup>
</table>
</section>
<section xml:id="win32service.constants.basepriorities">
<table>
<title>Win32 Base Priority Classes</title>
<tgroup cols="3">
<thead>
<row>
<entry>Constant</entry>
<entry>Value</entry>
<entry>Description</entry>
</row>
</thead>
<tbody>
<row>
<entry><constant>WIN32_ABOVE_NORMAL_PRIORITY_CLASS</constant></entry>
<entry>0x00008000</entry>
<entry>
Process that has priority above WIN32_NORMAL_PRIORITY_CLASS but below
WIN32_HIGH_PRIORITY_CLASS.
</entry>
</row>
<row>
<entry><constant>WIN32_BELOW_NORMAL_PRIORITY_CLASS</constant></entry>
<entry>0x00004000</entry>
<entry>
Process that has priority above WIN32_IDLE_PRIORITY_CLASS but below
WIN32_NORMAL_PRIORITY_CLASS.
</entry>
</row>
<row>
<entry><constant>WIN32_HIGH_PRIORITY_CLASS</constant></entry>
<entry>0x00000080</entry>
<entry>
Process that performs time-critical tasks that must be executed
immediately. The threads of the process preempt the threads of normal or
idle priority class processes. An example is the Task List, which must
respond quickly when called by the user, regardless of the load on the
operating system. Use extreme care when using the high-priority class,
because a high-priority class application can use nearly all available
CPU time.
</entry>
</row>
<row>
<entry><constant>WIN32_IDLE_PRIORITY_CLASS</constant></entry>
<entry>0x00000040</entry>
<entry>
Process whose threads run only when the system is idle. The threads of the
process are preempted by the threads of any process running in a higher
priority class. An example is a screen saver. The idle-priority class is
inherited by child processes.
</entry>
</row>
<row>
<entry><constant>WIN32_NORMAL_PRIORITY_CLASS</constant></entry>
<entry>0x00000020</entry>
<entry>
Process with no special scheduling needs.
</entry>
</row>
<row>
<entry><constant>WIN32_REALTIME_PRIORITY_CLASS</constant></entry>
<entry>0x00000100</entry>
<entry>
Process that has the highest possible priority. The threads of the
process preempt the threads of all other processes, including operating
system processes performing important tasks. For example, a real-time
process that executes for more than a very brief interval can cause disk
caches not to flush or cause the mouse to be unresponsive.
</entry>
</row>
</tbody>
</tgroup>
</table>
</section>
</appendix>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
sgml-omittag:t
sgml-shorttag:t
sgml-minimize-attributes:nil
sgml-always-quote-attributes:t
sgml-indent-step:1
sgml-indent-data:t
indent-tabs-mode:nil
sgml-parent-document:nil
sgml-default-dtd-file:"~/.phpdoc/manual.ced"
sgml-exposed-tags:nil
sgml-local-catalogs:nil
sgml-local-ecat-files:nil
End:
vim600: syn=xml fen fdm=syntax fdl=2 si
vim: et tw=78 syn=sgml
vi: ts=1 sw=1
-->