Sleep Method (PIXLClient)

Put the PIXL to sleep.

Syntax

Visual Basic
C#
C++/CLI

'Declaration
 
Public Function Sleep() As ApiCommandResponse

'Usage
 
Dim instance As PIXLClient
Dim value As ApiCommandResponse
 
value = instance.Sleep()

public ApiCommandResponse Sleep()

public:
ApiCommandResponse Sleep();

Return Value

The result of the action.

Remarks

It is recommended that the PIXL is left in a sleep state when it isn't being used for a long period of time as this will help prolong the life of some of the components.

Example

This sample shows how to use the Sleep method.

// Put the PIXL to sleep.
var result = pixl.Sleep();
            
// Display the result of the sleep operation based on if it was a success.
if (result.IsSuccess)
    Console.WriteLine("Sleep complete.");
else
    Console.WriteLine($"Sleep failed because {result.Message}");

Requirements

Target Platforms: Windows 7, Windows Vista SP1 or later, Windows XP SP3, Windows Server 2008 (Server Core not supported), Windows Server 2008 R2 (Server Core supported with SP1 or later), Windows Server 2003 SP2

Reference

PIXLClient Class
PIXLClient Members