3.1.5.13 R_FtpQueryStatistics2 (Opnum 12)

The R_FtpQueryStatistics2 method is called by the client. In response, the server returns statistical data from the FTP server.

 DWORD R_FtpQueryStatistics2(
   [in, string, unique] INET_INFO_IMPERSONATE_HANDLE pszServer,
   [in] DWORD dwLevel,
   [in] DWORD dwInstance,
   [in] DWORD dwReserved,
   [out, switch_is(dwLevel)] LPFTP_STATISTICS_STRUCT InfoStruct
 );

pszServer: The custom binding handle for the target system, as specified in section 2.1.1. The value MUST NOT be used by the server implementation.

dwLevel: The level of detail to be retrieved. This parameter MUST be set to 0 by the client. Other values MUST generate a return code of ERROR_INVALID_LEVEL (0x0000007C).

dwInstance: The ID of the protocol server instance whose statistical data is being requested. The following values have special meanings.

Value

Meaning

0x00000000

Return global (not per server instance) statistics data.

0xF0000003

Return statistics aggregated across all protocol server instances.

dwReserved: This value MUST be ignored by the server.

InfoStruct: The pointer to an FTP_STATISTICS_STRUCT union to contain the retrieved statistics data.

Return Values: The method returns 0 (ERROR_SUCCESS) to indicate success; otherwise, it returns a nonzero error code, as specified in [MS-ERREF] section 2.2 or [MS-ERREF] section 2.3.1. The most common error codes are listed in the following table.

Return value/code

Description

0x00000002

ERROR_FILE_NOT_FOUND

The system cannot find the specified file.

0x0000007C

ERROR_INVALID_LEVEL

The system call level is not correct.

0x00000426

ERROR_SERVICE_NOT_ACTIVE

The service is not running.

Exceptions Thrown: No exceptions are thrown beyond those thrown by the underlying RPC protocol, as specified in [MS-RPCE].

In response to this request from the client, the server MUST initialize InfoStruct with the statistical data for the FTP server if the return code indicates success.