Skip to main content
MI_DestinationOptions_GetCredentialsAt function

Get the credentials at the specified index.

Syntax


 MI_INLINE MI_Result MI_DestinationOptions_GetCredentialsAt(
  _In_       MI_DestinationOptions *options,
  MI_Uint32 index,
  const _Outptr_result_z_ MI_Char **optionName,
  _Out_      const MI_UserCredentials *credentials,
  _Out_opt_  MI_Uint32 *flags
);

Parameters

options [in]

MI_DestinationOptions object returned from MI_Application_NewDestinationOptions.

index

Zero-based index of the credentials.

optionName

Returned name of the credentials option.

credentials [out]

Returned MI_UserCredentials structure. If the credentials include a password, it will be filled with 6 asterisks for security purposes.

flags [out, optional]

Returned credentials option flags.

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