Skip to content

Commit 295b8f6

Browse files
committed
Doco
1 parent 1d74018 commit 295b8f6

File tree

1 file changed

+15
-1
lines changed

1 file changed

+15
-1
lines changed

include/EFW1_7.cs

Lines changed: 15 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -65,7 +65,21 @@ public struct EFW_INFO : IZWODeviceInfo
6565
[DllImport(EFWSharedLib, EntryPoint = "EFWClose", CallingConvention = CallingConvention.Cdecl)]
6666
public static extern EFW_ERROR_CODE EFWClose(int ID);
6767

68-
68+
/// <summary>
69+
/// get position of slot
70+
/// </summary>
71+
/// <param name="ID">the ID of filter wheel</param>
72+
/// <param name="pPosition">pointer to slot position, this value is between 0 to M - 1, M is slot number and -1 if filter wheel is moving</param>
73+
/// <returns>
74+
/// <list type="table">
75+
/// <listheader><term>Code</term><description>Meaning</description></listheader>
76+
/// <item><term>EFW_ERROR_INVALID_ID</term><description>invalid ID value</description></item>
77+
/// <item><term>EFW_ERROR_CLOSED</term><description>filter wheel disconnected/not opened</description></item>
78+
/// <item><term>EFW_ERROR_REMOVED</term><description>filter wheel is removed</description></item>
79+
/// <item><term>EFW_ERROR_REMOVED</term><description>focuser is removed</description></item>
80+
/// <item><term>EFW_ERROR_ERROR_STATE</term><description>operation succeeds</description></item>
81+
/// </list>
82+
/// </returns>
6983
[DllImport(EFWSharedLib, EntryPoint = "EFWGetPosition", CallingConvention = CallingConvention.Cdecl)]
7084
public static extern EFW_ERROR_CODE EFWGetPosition(int ID, out int pPosition);
7185

0 commit comments

Comments
 (0)