FilesExpand file tree

 master

/

VoidResult.cs

Copy path

Blame

More file actions

Blame

More file actions

Latest commit

 

History

History

History

45 lines (40 loc) · 1.47 KB

 master

/

VoidResult.cs

Copy path

Top

File metadata and controls

• Code
• Blame

45 lines (40 loc) · 1.47 KB

Raw

Copy raw file

Download raw file

Open symbols panel

Edit and raw actions

1

2

3

4

5

6

7

8

9

10

11

12

13

14

15

16

17

18

19

20

21

22

23

24

25

26

27

28

29

30

31

32

33

34

35

36

37

38

39

40

41

42

43

44

45

// Copyright (c) Microsoft Corporation. All rights reserved.

// Licensed under the MIT license.

namespace Microsoft.ClearScript

{

/// <summary>

/// Represents the result of a host method that returns no value.

/// </summary>

/// <remarks>

/// Some script languages expect every subroutine call to return a value. When script code

/// written in such a language invokes a host method that explicitly returns no value (such

/// as a C#

/// <c><see href="https://docs.microsoft.com/en-us/dotnet/csharp/language-reference/keywords/void">void</see></c>

/// method), the ClearScript library provides an instance of this class as a dummy return

/// value.

/// </remarks>

/// <c><seealso cref="ScriptEngine.VoidResultValue"/></c>

public class VoidResult

{

/// <summary>

/// The sole instance of the <c><see cref="VoidResult"/></c> class.

/// </summary>

public static readonly VoidResult Value = new();

private VoidResult()

{

}

#region Object overrides

/// <summary>

/// Returns a string that represents the current object.

/// </summary>

/// <returns>A string that represents the current object.</returns>

/// <remarks>

/// The <c><see cref="VoidResult"/></c> version of this method returns "[void]".

/// </remarks>

public override string ToString()

{

return "[void]";

}

#endregion

}

}