Java Native Access Platform 5.14.0 · com.sun.jna.platform.win32.W32Service

Modifier and Type	Field and Description
pack-priv Winsvc.SC_HANDLE	_handle

Access	Constructor and Description
public	W32Service(Winsvc.SC_HANDLE A handle to the service. This handle is returned by the CreateService or OpenService function, and it must have the SERVICE_QUERY_STATUS access right. handle) Win32 Service

Method Summary

Modifier and Type Method and Description

private void

addShutdownPrivilegeToProcess()

public void

close()

Implements java.io.Closeable.close.

Close service.

public void

continueService()

Continue service.

public Winsvc.ENUM_SERVICE_STATUS[]

Returns:

array of ENUM_SERVICE_STATUS structures that receives the name and service status information for each dependent service in the database.

enumDependentServices(int

The state of the services to be enumerated. This parameter can be one of the following values.

Value	Meaning
`Winsvc#SERVICE_ACTIVE`	Enumerates services that are in the following states: `Winsvc#SERVICE_START_PENDING`, `Winsvc#SERVICE_STOP_PENDING`, `Winsvc#SERVICE_RUNNING`, `Winsvc#SERVICE_CONTINUE_PENDING`, `Winsvc#SERVICE_PAUSE_PENDING`, and `Winsvc#SERVICE_PAUSED`.
`Winsvc#SERVICE_INACTIVE`	Enumerates services that are in the `Winsvc#SERVICE_STOPPED` state.
`Winsvc#SERVICE_STATE_ALL`	Combines the following states: `Winsvc#SERVICE_ACTIVE` and `Winsvc#SERVICE_INACTIVE`.

dwServiceState)

Retrieves the name and status of each service that depends on the specified service; that is, the specified service must be running before the dependent services can run.

public Winsvc.SERVICE_FAILURE_ACTIONS

getFailureActions()

Get the failure actions of the specified service.

public boolean

getFailureActionsFlag()

Get the failure actions flag of the specified service.

public Winsvc.SC_HANDLE

Returns:

Returns the service handle.

getHandle()

Gets the service handle.

private boolean

isPendingState(int state)

public void

pauseService()

Pause service.

private Pointer

queryServiceConfig2(int type)

public Winsvc.SERVICE_STATUS_PROCESS

Returns:

Service status information

queryStatus()

Retrieves the current status of the specified service based on the specified information level.

pack-priv int

sanitizeWaitTime(int dwWaitHint)

do not wait longer than the wait hint.

public void

setFailureActions(List<Winsvc.SC_ACTION> actions, int resetPeriod, String rebootMsg, String command)

Set the failure actions of the specified service.

public void

setFailureActionsFlag(boolean flagValue)

Set the failure action flag of the specified service.

public void

startService()

public void

stopService()

Stop service.

public void

stopService(long

timeout in ms until the service must report to be stopped

timeout)

Stop service.

public void

waitForNonPendingState()

Wait for the state to change to something other than a pending state.

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

_handle	back to summary
pack-priv Winsvc.SC_HANDLE _handle

W32Service	back to summary
public W32Service(Winsvc.SC_HANDLE handle) Win32 Service Parameters handle:Winsvc.SC_HANDLE A handle to the service. This handle is returned by the CreateService or OpenService function, and it must have the SERVICE_QUERY_STATUS access right.

Method Detail

addShutdownPrivilegeToProcess	back to summary
private void addShutdownPrivilegeToProcess()

close	back to summary
public void close() Implements java.io.Closeable.close. Close service. Annotations @Override

back to summary

public void close()

Implements java.io.Closeable.close.

Close service.

Annotations

@Override

continueService	back to summary
public void continueService() Continue service.

enumDependentServices back to summary

public Winsvc.ENUM_SERVICE_STATUS[] enumDependentServices(int dwServiceState)

Retrieves the name and status of each service that depends on the specified service; that is, the specified service must be running before the dependent services can run.

Parameters

dwServiceState:int

The state of the services to be enumerated. This parameter can be one of the following values.

Value	Meaning
`Winsvc#SERVICE_ACTIVE`	Enumerates services that are in the following states: `Winsvc#SERVICE_START_PENDING`, `Winsvc#SERVICE_STOP_PENDING`, `Winsvc#SERVICE_RUNNING`, `Winsvc#SERVICE_CONTINUE_PENDING`, `Winsvc#SERVICE_PAUSE_PENDING`, and `Winsvc#SERVICE_PAUSED`.
`Winsvc#SERVICE_INACTIVE`	Enumerates services that are in the `Winsvc#SERVICE_STOPPED` state.
`Winsvc#SERVICE_STATE_ALL`	Combines the following states: `Winsvc#SERVICE_ACTIVE` and `Winsvc#SERVICE_INACTIVE`.

Returns:Winsvc.ENUM_SERVICE_STATUS[]

array of ENUM_SERVICE_STATUS structures that receives the name and service status information for each dependent service in the database.

getFailureActions	back to summary
public Winsvc.SERVICE_FAILURE_ACTIONS getFailureActions() Get the failure actions of the specified service. Corresponds to QueryServiceConfig2 with parameter dwInfoLevel set to SERVICE_CONFIG_FAILURE_ACTIONS.

getFailureActionsFlag	back to summary
public boolean getFailureActionsFlag() Get the failure actions flag of the specified service. Corresponds to QueryServiceConfig2 with parameter dwInfoLevel set to SERVICE_CONFIG_FAILURE_ACTIONS_FLAG.

getHandle	back to summary
public Winsvc.SC_HANDLE getHandle() Gets the service handle. Returns:Winsvc.SC_HANDLE Returns the service handle.

getHandle

back to summary

public Winsvc.SC_HANDLE getHandle()

Gets the service handle.

Returns:Winsvc.SC_HANDLE: Returns the service handle.

isPendingState	back to summary
private boolean isPendingState(int state)

pauseService	back to summary
public void pauseService() Pause service.

queryServiceConfig2	back to summary
private Pointer queryServiceConfig2(int type)

queryStatus	back to summary
public Winsvc.SERVICE_STATUS_PROCESS queryStatus() Retrieves the current status of the specified service based on the specified information level. Returns:Winsvc.SERVICE_STATUS_PROCESS Service status information

queryStatus

back to summary

public Winsvc.SERVICE_STATUS_PROCESS queryStatus()

Retrieves the current status of the specified service based on the specified information level.

Returns:Winsvc.SERVICE_STATUS_PROCESS: Service status information

sanitizeWaitTime	back to summary
pack-priv int sanitizeWaitTime(int dwWaitHint) do not wait longer than the wait hint. A good interval is one-tenth the wait hint, but no less than 1 second and no more than 10 seconds.

setFailureActions	back to summary
public void setFailureActions(List<Winsvc.SC_ACTION> actions, int resetPeriod, String rebootMsg, String command) Set the failure actions of the specified service. Corresponds to ChangeServiceConfig2 with parameter dwInfoLevel set to SERVICE_CONFIG_FAILURE_ACTIONS.

setFailureActionsFlag	back to summary
public void setFailureActionsFlag(boolean flagValue) Set the failure action flag of the specified service. Corresponds to ChangeServiceConfig2 with parameter dwInfoLevel set to SERVICE_CONFIG_FAILURE_ACTIONS_FLAG.

startService	back to summary
public void startService()

stopService	back to summary
public void stopService() Stop service.

stopService	back to summary
public void stopService(long timeout) Stop service. Parameters timeout:long timeout in ms until the service must report to be stopped

stopService

back to summary

public void stopService(long timeout)

Stop service.

Parameters

timeout:long: timeout in ms until the service must report to be stopped

waitForNonPendingState	back to summary
public void waitForNonPendingState() Wait for the state to change to something other than a pending state.

public Class W32Service

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail