Edit

MprConfigTransportEnum function (mprapi.h)

  • Article

The MprConfigTransportEnum function enumerates the transports configured on the router.

Syntax

DWORD MprConfigTransportEnum(
  [in]                HANDLE  hMprConfig,
  [in]                DWORD   dwLevel,
  [in, out]           LPBYTE  *lplpBuffer,
  [in]                DWORD   dwPrefMaxLen,
  [out]               LPDWORD lpdwEntriesRead,
  [out]               LPDWORD lpdwTotalEntries,
  [in, out, optional] LPDWORD lpdwResumeHandle
);

Parameters

[in] hMprConfig

Handle to the router configuration for the transports. Obtain this handle by calling MprConfigServerConnect.

[in] dwLevel

A DWORD value that describes the format in which the information is returned in the lplpBuffer parameter. Must be zero.

[in, out] lplpBuffer

On input, a non-NULL pointer.

On successful completion, a pointer to an array of MPR_TRANSPORT_0 structures. Free this memory buffer by calling MprConfigBufferFree.

[in] dwPrefMaxLen

Specifies the preferred maximum length of returned data in 8-bit bytes. If this parameter is -1, the buffer returned will be large enough to hold all available information.

[out] lpdwEntriesRead

Pointer to a DWORD variable. This variable receives the total number of entries that were enumerated from the current resume position.

[out] lpdwTotalEntries

Pointer to a DWORD variable. This variable receives the total number of entries that could have been enumerated from the current resume position.

[in, out, optional] lpdwResumeHandle

Pointer to a DWORD variable.

On input, the handle should be zero on the first call and left unchanged on subsequent calls.

On output, this variable contains a resume handle used to continue the enumeration. If the handle is NULL, the enumeration is complete.

If an error occurs in the enumeration, this handle is invalid.

This parameter is optional. If the calling application specifies NULL for this parameter, the function does not return a resume handle.

Return value

If the function succeeds, the return value is NO_ERROR.

If the function fails, the return value is one of the following error codes.

Value Meaning
ERROR_INVALID_PARAMETER
 At least one of the following is true:
  • hMprConfig is NULL.
  • dwLevel is not zero.
  • lplpBuffer is NULL.
  • dwPrefMaxLen is smaller than the size of a single MPR_TRANSPORT_0 structure.
  • lpdwEntriesRead is NULL.
  • lpdwTotalEntries is NULL.
ERROR_NOT_ENOUGH_MEMORY
 Insufficient resources to complete the operation.
ERROR_NO_MORE_ITEMS
 No more entries available from the current resume position.
Other
 Use FormatMessage to retrieve the system error message that corresponds to the error code returned.

Requirements

Requirement Value
Minimum supported client None supported
Minimum supported server Windows 2000 Server [desktop apps only]
Target Platform Windows
Header mprapi.h
Library Mprapi.lib
DLL Mprapi.dll

See also

FormatMessage

MprConfigBufferFree

MprConfigServerConnect

Router Configuration Functions

Router Management Reference