Skip to main content
MI_DestinationOptions_GetMaxEnvelopeSize function

Gets the maximum size of the packet sent to a server or received by the client from the server.

Syntax


MI_Result MI_DestinationOptions_GetMaxEnvelopeSize(
  _In_   MI_DestinationOptions *options,
  _Out_  MI_Uint32 *sizeInKB
);

Parameters

options [in]

MI_DestinationOptions object returned from MI_Application_NewDestinationOptions.

sizeInKB [out]

Returned packet size.

Return value

A value of the MI_Result enumeration that specifies the function return code. This can be one of the following codes.

Return codeDescription
MI_RESULT_OK

The operation succeeded.

MI_RESULT_SERVER_LIMITS_EXCEEDED

There is not enough memory to complete the request.

MI_RESULT_INVALID_PARAMETER

One or more parameters passed to the function were not valid.

MI_RESULT_FAILED

A failure not covered by other MI_Result error codes.

 

Requirements

Minimum supported client

Windows 8

Minimum supported server

Windows Server 2012

Redistributable

Windows Management Framework 3.0 on Windows Server 2008 R2 with SP1, Windows 7 with SP1, and Windows Server 2008 with SP2

Header

Mi.h