archive
/
windows-xp
mirror of https://github.com/tongzx/nt5src
2
0
Fork 0
Code Issues Projects Releases Wiki Activity
Source code of Windows XP (NT5)
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
6 Commits
1 Branch
0 Tags
3.8 GiB
Branch: master
Branches Tags
${ item.name }
Create tag ${ searchTerm }
Create branch ${ searchTerm }
from 'master'
${ noResults }
windows-xp/Source/XPSP1/NT/public/internal/termsrv/inc/cchannel.h

441 lines
26 KiB
Raw Permalink Normal View History

Add source files
4 years ago
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
  1. /****************************************************************************/
  2. /* Header: cchannel.h */
  3. /* */
  4. /* Purpose: Virtual Channel Client API */
  5. /* */
  6. /* Copyright(C) Microsoft Corporation 1999 */
  7. /* */
  8. /****************************************************************************/
  10. #ifndef H_CCHANNEL
  11. #define H_CCHANNEL
  13. /****************************************************************************/
  14. /* Include Virtual Channel Protocol header */
  15. /****************************************************************************/
  16. #include <pchannel.h>
  18. #ifdef _WIN32
  19. #define VCAPITYPE _stdcall
  20. #define VCEXPORT
  21. #else // _WIN32
  22. #define VCAPITYPE CALLBACK
  23. #define VCEXPORT __export
  24. #endif // _WIN32
  26. /****************************************************************************/
  27. /* Name: CHANNEL_INIT_EVENT_FN */
  28. /* */
  29. /* Purpose: */
  30. /* */
  31. /* This function is passed to MSTSC on VirtualChannelInit. It is called by */
  32. /* MSTSC to tell the application about interesting events. */
  33. /* */
  34. /* Returns: */
  35. /* */
  36. /* none */
  37. /* */
  38. /* Params: */
  39. /* */
  40. /* - pInitHandle - a handle uniquely identifying this connection */
  41. /* - event - the event that has occurred - see CHANNEL_EVENT_XXX below */
  42. /* - pData - data associated with the event - see CHANNEL_EVENT_XXX below */
  43. /* - dataLength - length of the data. */
  44. /* */
  45. /****************************************************************************/
  46. typedef VOID VCAPITYPE CHANNEL_INIT_EVENT_FN(LPVOID pInitHandle,
  47. UINT event,
  48. LPVOID pData,
  49. UINT dataLength);
  51. typedef CHANNEL_INIT_EVENT_FN FAR * PCHANNEL_INIT_EVENT_FN;
  53. typedef VOID VCAPITYPE CHANNEL_INIT_EVENT_EX_FN(LPVOID lpUserParam,
  54. LPVOID pInitHandle,
  55. UINT event,
  56. LPVOID pData,
  57. UINT dataLength);
  59. typedef CHANNEL_INIT_EVENT_EX_FN FAR * PCHANNEL_INIT_EVENT_EX_FN;
  62. /****************************************************************************/
  63. /* Events passed to VirtualChannelInitEvent */
  64. /****************************************************************************/
  65. /* Client initialized (no data) */
  66. #define CHANNEL_EVENT_INITIALIZED 0
  68. /* Connection established (data = name of Server) */
  69. #define CHANNEL_EVENT_CONNECTED 1
  71. /* Connection established with old Server, so no channel support */
  72. #define CHANNEL_EVENT_V1_CONNECTED 2
  74. /* Connection ended (no data) */
  75. #define CHANNEL_EVENT_DISCONNECTED 3
  77. /* Client terminated (no data) */
  78. #define CHANNEL_EVENT_TERMINATED 4
  80. /* Remote control is starting on this client */
  81. #define CHANNEL_EVENT_REMOTE_CONTROL_START 5
  83. /* Remote control is ending on this client */
  84. #define CHANNEL_EVENT_REMOTE_CONTROL_STOP 6
  86. /****************************************************************************/
  87. /* Name: CHANNEL_OPEN_EVENT_FN */
  88. /* */
  89. /* Purpose: */
  90. /* */
  91. /* This function is passed to MSTSC on VirtualChannelOpen. It is called by */
  92. /* MSTSC when data is available on the channel. */
  93. /* */
  94. /* Returns: */
  95. /* */
  96. /* none */
  97. /* */
  98. /* Params: */
  99. /* */
  100. /* - openHandle - a handle uniquely identifying this channel */
  101. /* - event - event that has occurred - see CHANNEL_EVENT_XXX below */
  102. /* - pData - data received */
  103. /* - dataLength - length of the data */
  104. /* - totalLength - total length of data written by the Server */
  105. /* - dataFlags - flags, zero, one or more of: */
  106. /* - 0x01 - beginning of data from a single write operation at the Server */
  107. /* - 0x02 - end of data from a single write operation at the Server. */
  108. /* */
  109. /****************************************************************************/
  110. typedef VOID VCAPITYPE CHANNEL_OPEN_EVENT_FN(DWORD openHandle,
  111. UINT event,
  112. LPVOID pData,
  113. UINT32 dataLength,
  114. UINT32 totalLength,
  115. UINT32 dataFlags);
  117. typedef CHANNEL_OPEN_EVENT_FN FAR * PCHANNEL_OPEN_EVENT_FN;
  119. typedef VOID VCAPITYPE CHANNEL_OPEN_EVENT_EX_FN(LPVOID lpUserParam,
  120. DWORD openHandle,
  121. UINT event,
  122. LPVOID pData,
  123. UINT32 dataLength,
  124. UINT32 totalLength,
  125. UINT32 dataFlags);
  127. typedef CHANNEL_OPEN_EVENT_EX_FN FAR * PCHANNEL_OPEN_EVENT_EX_FN;
  130. /****************************************************************************/
  131. /* Events passed to VirtualChannelOpenEvent */
  132. /****************************************************************************/
  133. /* Data received from Server (data = incoming data) */
  134. #define CHANNEL_EVENT_DATA_RECEIVED 10
  136. /* VirtualChannelWrite completed (pData - pUserData passed on
  137. VirtualChannelWrite) */
  138. #define CHANNEL_EVENT_WRITE_COMPLETE 11
  140. /* VirtualChannelWrite cancelled (pData - pUserData passed on
  141. VirtualChannelWrite) */
  142. #define CHANNEL_EVENT_WRITE_CANCELLED 12
  145. /****************************************************************************/
  146. /* Return codes from VirtualChannelXxx functions */
  147. /****************************************************************************/
  148. #define CHANNEL_RC_OK 0
  149. #define CHANNEL_RC_ALREADY_INITIALIZED 1
  150. #define CHANNEL_RC_NOT_INITIALIZED 2
  151. #define CHANNEL_RC_ALREADY_CONNECTED 3
  152. #define CHANNEL_RC_NOT_CONNECTED 4
  153. #define CHANNEL_RC_TOO_MANY_CHANNELS 5
  154. #define CHANNEL_RC_BAD_CHANNEL 6
  155. #define CHANNEL_RC_BAD_CHANNEL_HANDLE 7
  156. #define CHANNEL_RC_NO_BUFFER 8
  157. #define CHANNEL_RC_BAD_INIT_HANDLE 9
  158. #define CHANNEL_RC_NOT_OPEN 10
  159. #define CHANNEL_RC_BAD_PROC 11
  160. #define CHANNEL_RC_NO_MEMORY 12
  161. #define CHANNEL_RC_UNKNOWN_CHANNEL_NAME 13
  162. #define CHANNEL_RC_ALREADY_OPEN 14
  163. #define CHANNEL_RC_NOT_IN_VIRTUALCHANNELENTRY 15
  164. #define CHANNEL_RC_NULL_DATA 16
  165. #define CHANNEL_RC_ZERO_LENGTH 17
  166. #define CHANNEL_RC_INVALID_INSTANCE 18
  167. #define CHANNEL_RC_UNSUPPORTED_VERSION 19
  169. /****************************************************************************/
  170. /* Levels of Virtual Channel Support */
  171. /****************************************************************************/
  172. #define VIRTUAL_CHANNEL_VERSION_WIN2000 1
  174. #ifdef __cplusplus
  175. extern "C" {
  176. #endif /* __cplusplus */
  177. /****************************************************************************/
  178. /* Name: VirtualChannelInit */
  179. /* */
  180. /* Purpose: */
  181. /* */
  182. /* This function is called by the application to register the virtual */
  183. /* channels it wants to have access to. Note that this does not open the */
  184. /* channels, merely reserves the names for use by this application. This */
  185. /* function must be called before the Client connects to the Server, hence */
  186. /* it is recommended that it is called from the DLL's initialization */
  187. /* procedure. */
  188. /* */
  189. /* */
  190. /* On_return, the channels requested have been registered. However, other */
  191. /* MSTSC initialization may not yet have completed. The application */
  192. /* receives a VirtualChannelInitEvent callback with the "Client */
  193. /* initialized" event when all MSTSC initialization is complete. */
  194. /* */
  195. /* Returns: */
  196. /* */
  197. /* CHANNEL_RC_OK */
  198. /* CHANNEL_RC_ALREADY_INITIALIZED */
  199. /* CHANNEL_RC_ALREADY_CONNECTED */
  200. /* CHANNEL_RC_TOO_MANY_CHANNELS */
  201. /* CHANNEL_RC_NOT_IN_VIRTUALCHANNELENTRY */
  202. /* */
  203. /* Parameters */
  204. /* */
  205. /* - ppInitHandle (returned) - handle to pass to subsequent */
  206. /* VirtualChannelXxx calls */
  207. /* - pChannel - list of names registered by this application */
  208. /* - channelCount - number of channels registered. */
  209. /* - versionRequested - level of virtual channel support requested (one of */
  210. /* the VIRTUAL_CHANNEL_LEVEL_XXX parameters) */
  211. /* - pChannelInitEventProc - address of VirtualChannelInitEvent procedure */
  212. /* */
  213. /****************************************************************************/
  214. typedef UINT VCAPITYPE VIRTUALCHANNELINIT(
  215. LPVOID FAR * ppInitHandle,
  216. PCHANNEL_DEF pChannel,
  217. INT channelCount,
  218. ULONG versionRequested,
  219. PCHANNEL_INIT_EVENT_FN pChannelInitEventProc);
  221. typedef VIRTUALCHANNELINIT FAR * PVIRTUALCHANNELINIT;
  223. /****************************************************************************/
  224. /* Parameters for EX version */
  225. /* */
  226. /* pUserParam - user definded value that will be passed back */
  227. /* to addin in callbacks */
  228. /* */
  229. /* - pInitHandle - handle passed in in entry function */
  230. /* - pChannel - list of names registered by this application */
  231. /* - channelCount - number of channels registered. */
  232. /* - versionRequested - level of virtual channel support requested (one of */
  233. /* the VIRTUAL_CHANNEL_LEVEL_XXX parameters) */
  234. /* - pChannelInitEventProc - address of VirtualChannelInitEvent procedure */
  235. /* */
  236. /****************************************************************************/
  238. typedef UINT VCAPITYPE VIRTUALCHANNELINITEX(
  239. LPVOID lpUserParam,
  240. LPVOID pInitHandle,
  241. PCHANNEL_DEF pChannel,
  242. INT channelCount,
  243. ULONG versionRequested,
  244. PCHANNEL_INIT_EVENT_EX_FN pChannelInitEventProcEx);
  246. typedef VIRTUALCHANNELINITEX FAR * PVIRTUALCHANNELINITEX;
  250. /****************************************************************************/
  251. /* Name: VirtualChannelOpen */
  252. /* */
  253. /* Purpose: */
  254. /* */
  255. /* This function is called by the application to open a channel. It cannot */
  256. /* be called until a connection is established with a Server. */
  257. /* */
  258. /* Returns: */
  259. /* */
  260. /* CHANNEL_RC_OK */
  261. /* CHANNEL_RC_NOT_INITIALIZED */
  262. /* CHANNEL_RC_NOT_CONNECTED */
  263. /* CHANNEL_RC_BAD_CHANNEL_NAME */
  264. /* CHANNEL_RC_BAD_INIT_HANDLE */
  265. /* */
  266. /* Params: */
  267. /* */
  268. /* - pInitHandle - handle from VirtualChannelInit */
  269. /* */
  270. /* - pOpenHandle (returned) - handle to pass to subsequent */
  271. /* VirtualChannelXxx calls */
  272. /* - pChannelName - name of channel to open */
  273. /* - pChannelOpenEventProc - address of VirtualChannelOpenEvent procedure */
  274. /* */
  275. /****************************************************************************/
  276. typedef UINT VCAPITYPE VIRTUALCHANNELOPEN(
  277. LPVOID pInitHandle,
  278. LPDWORD pOpenHandle,
  279. PCHAR pChannelName,
  280. PCHANNEL_OPEN_EVENT_FN pChannelOpenEventProc);
  282. typedef VIRTUALCHANNELOPEN FAR * PVIRTUALCHANNELOPEN;
  284. typedef UINT VCAPITYPE VIRTUALCHANNELOPENEX(
  285. LPVOID pInitHandle,
  286. LPDWORD pOpenHandle,
  287. PCHAR pChannelName,
  288. PCHANNEL_OPEN_EVENT_EX_FN pChannelOpenEventProcEx);
  290. typedef VIRTUALCHANNELOPENEX FAR * PVIRTUALCHANNELOPENEX;
  293. /****************************************************************************/
  294. /* Name: VirtualChannelClose */
  295. /* */
  296. /* Purpose: */
  297. /* */
  298. /* This function is called to close a previously opened channel. */
  299. /* */
  300. /* Returns: */
  301. /* */
  302. /* CHANNEL_RC_OK */
  303. /* CHANNEL_RC_BAD_CHANNEL_HANDLE */
  304. /* */
  305. /* Params: */
  306. /* */
  307. /* - (EX version) pInitHandle - handle identifying the client instance */
  308. /* - openHandle - handle returned on VirtualChannelOpen */
  309. /* */
  310. /****************************************************************************/
  311. typedef UINT VCAPITYPE VIRTUALCHANNELCLOSE(DWORD openHandle);
  313. typedef VIRTUALCHANNELCLOSE FAR * PVIRTUALCHANNELCLOSE;
  315. typedef UINT VCAPITYPE VIRTUALCHANNELCLOSEEX(LPVOID pInitHandle,
  316. DWORD openHandle);
  318. typedef VIRTUALCHANNELCLOSEEX FAR * PVIRTUALCHANNELCLOSEEX;
  321. /****************************************************************************/
  322. /* Name: VirtualChannelWrite */
  323. /* */
  324. /* Purpose: */
  325. /* */
  326. /* This function is used to send data to the partner app on the Server. */
  327. /* */
  328. /* VirtualChannelWrite copies the data to one or more network buffers as */
  329. /* necessary. VirtualChannelWrite ensures that data is sent to the Server */
  330. /* on the right context. It sends all data on MS TC's Sender thread. */
  331. /* */
  332. /* VirtualChannelWrite is asynchronous - the VirtualChannelOpenEvent */
  333. /* procedure is called when the write completes. Until that callback is */
  334. /* made, the caller must not free or reuse the buffer passed on */
  335. /* VirtualChannelWrite. The caller passes a piece of data (pUserData) to */
  336. /* VirtualChannelWrite, which is returned on the VirtualChannelOpenEvent */
  337. /* callback. The caller can use this data to identify the write which has */
  338. /* completed. */
  339. /* */
  340. /* */
  341. /* Returns: */
  342. /* */
  343. /* CHANNEL_RC_OK */
  344. /* CHANNEL_RC_NOT_INITIALIZED */
  345. /* CHANNEL_RC_NOT_CONNECTED */
  346. /* CHANNEL_RC_BAD_CHANNEL_HANDLE */
  347. /* */
  348. /* Params: */
  349. /* - (EX version) pInitHandle - handle identifying the client instance */
  350. /* - openHandle - handle from VirtualChannelOpen */
  351. /* - pData - data to write */
  352. /* - datalength - length of data to write */
  353. /* - pUserData - user supplied data, returned on VirtualChannelOpenEvent */
  354. /* when the write completes */
  355. /* */
  356. /****************************************************************************/
  357. typedef UINT VCAPITYPE VIRTUALCHANNELWRITE(DWORD openHandle,
  358. LPVOID pData,
  359. ULONG dataLength,
  360. LPVOID pUserData);
  362. typedef VIRTUALCHANNELWRITE FAR * PVIRTUALCHANNELWRITE;
  364. typedef UINT VCAPITYPE VIRTUALCHANNELWRITEEX(LPVOID pInitHandle,
  365. DWORD openHandle,
  366. LPVOID pData,
  367. ULONG dataLength,
  368. LPVOID pUserData);
  370. typedef VIRTUALCHANNELWRITEEX FAR * PVIRTUALCHANNELWRITEEX;
  373. /****************************************************************************/
  374. /* Structure: CHANNEL_ENTRY_POINTS */
  375. /* */
  376. /* Description: Virtual Channel entry points passed to VirtualChannelEntry */
  377. /****************************************************************************/
  378. typedef struct tagCHANNEL_ENTRY_POINTS
  379. {
  380. DWORD cbSize;
  381. DWORD protocolVersion;
  382. PVIRTUALCHANNELINIT pVirtualChannelInit;
  383. PVIRTUALCHANNELOPEN pVirtualChannelOpen;
  384. PVIRTUALCHANNELCLOSE pVirtualChannelClose;
  385. PVIRTUALCHANNELWRITE pVirtualChannelWrite;
  386. } CHANNEL_ENTRY_POINTS, FAR * PCHANNEL_ENTRY_POINTS;
  388. typedef struct tagCHANNEL_ENTRY_POINTS_EX
  389. {
  390. DWORD cbSize;
  391. DWORD protocolVersion;
  392. PVIRTUALCHANNELINITEX pVirtualChannelInitEx;
  393. PVIRTUALCHANNELOPENEX pVirtualChannelOpenEx;
  394. PVIRTUALCHANNELCLOSEEX pVirtualChannelCloseEx;
  395. PVIRTUALCHANNELWRITEEX pVirtualChannelWriteEx;
  396. } CHANNEL_ENTRY_POINTS_EX, FAR * PCHANNEL_ENTRY_POINTS_EX;
  400. /****************************************************************************/
  401. /* Name: VirtualChannelEntry */
  402. /* */
  403. /* Purpose: */
  404. /* */
  405. /* This function is provided by addin DLLS. It is called by MSTSC at */
  406. /* initialization to tell the addin DLL the addresses of the */
  407. /* VirtualChannelXxx functions. */
  408. /* */
  409. /* Returns: */
  410. /* */
  411. /* TRUE - everything OK */
  412. /* FALSE - error, unload the DLL */
  413. /* */
  414. /* Parameters: */
  415. /* */
  416. /* - pVirtualChannelInit - pointers to VirtualChannelXxx functions */
  417. /* - pVirtualChannelOpen */
  418. /* - pVirtualChannelClose */
  419. /* - pVirtualChannelWrite */
  420. /* */
  421. /* - (EX version) pInitHandle - value that identifies client instance */
  422. /* this must be passed back when calling into */
  423. /* the client. */
  424. /****************************************************************************/
  425. typedef BOOL VCAPITYPE VIRTUALCHANNELENTRY(
  426. PCHANNEL_ENTRY_POINTS pEntryPoints);
  428. typedef VIRTUALCHANNELENTRY FAR * PVIRTUALCHANNELENTRY;
  430. typedef BOOL VCAPITYPE VIRTUALCHANNELENTRYEX(
  431. PCHANNEL_ENTRY_POINTS_EX pEntryPointsEx,
  432. PVOID pInitHandle);
  434. typedef VIRTUALCHANNELENTRYEX FAR * PVIRTUALCHANNELENTRYEX;
  437. #ifdef __cplusplus
  438. }
  439. #endif /* __cplusplus */
  441. #endif /* H_CCHANNEL */