NetHandleGetInfo

The NetHandleGetInfo function retrieves handle-specific information for character-device and named-pipe handles.

Security Requirements

Access restrictions to the named pipe or character device also determine access privileges to NetHandleGetInfo.

NET_API_STATUS NetHandleGetInfo(
  UNSIGNED SHORT hHandle,             
  SHORT sLevel,                       
  CHAR FAR *pbBuffer,                 
  UNSIGNED SHORT cbBuffer,            
  UNSIGNED SHORT FAR *pcbTotalAvail   
);
 

Parameters

hHandle

Identifies a communication-device queue or a named pipe.

sLevel

Specifies the level of detail (1 or 2) requested.

Note  The NetHandleGetInfo function can be called at level 1 only if the value of the hHandle parameter is a valid handle to a named pipe or character device that exists on a remote server.

The NetHandleGetInfo function can be called at level 2 only if the value of the hHandle parameter is a handle to the server side of a valid named pipe opened on a remote computer. If the named pipe has been opened locally or if the handle is not for a named pipe, NetHandleGetInfo returns ERROR_INVALID_PARAMETER.

pbBuffer

Pointer to the buffer in which to store the returned data. If the function returns successfully, the buffer contains a handle_info_1 structure.

cbBuffer

Specifies the size, in bytes, of the data buffer pointed to by the pbBuffer parameter.

pcbTotalAvail

Pointer to an unsigned short integer in which the total number of bytes of information available is returned. This count is valid only if NetHandleGetInfo returns nerr_success, error_more_data, or nerr_buftoosmall.

QuickInfo

  Windows NT: Requires version 3.1 or later.
  Windows: Unsupported.
  Windows CE: Unsupported.
  Header: Declared in lmchdev.h.
  Import Library: Use netapi32.lib.

See Also

Networking (Net) Overview, Net Functions, HANDLE_INFO_1, NetHandleSetInfo