Expand Minimize

MI_DestinationOptions_GetPacketEncoding function

Gets the previously set packet encoding setting.

Syntax


 MI_INLINE MI_Result MI_DestinationOptions_GetPacketEncoding(
  _In_  MI_DestinationOptions *options,
  _Outptr_result_z_ const MI_Char **encoding
);

Parameters

options [in]

MI_DestinationOptions object returned from MI_Application_NewDestinationOptions.

encoding

A pointer to a null-terminated string containing the returned encoding setting. Here are the possible values:

ValueMeaning
MI_DESTINATIONOPTIONS_PACKET_ENCODING_DEFAULT
"default"

Transport-specific default encoding per the WinRM protocol handler.

MI_DESTINATIONOPTIONS_PACKET_ENCODING_UTF8
"UTF8"

UTF-8 encoding.

MI_DESTINATIONOPTIONS_PACKET_ENCODING_UTF16
"UTF16"

UTF-16 encoding.

 

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

See also

Windows Remote Management

 

 

Show:
© 2015 Microsoft