Export (0) Print
Expand All
Expand Minimize

MI_DestinationOptions_GetCredentialsPasswordAt function

Gets a credentials password based on a specified index.

Syntax


 MI_INLINE MI_Result MI_DestinationOptions_GetCredentialsPasswordAt(
  _In_       MI_DestinationOptions *options,
  MI_Uint32 index,
  _Outptr_result_z_ const MI_Char **optionName,
  _Out_writes_to_opt_(bufferLength, *passwordLength) MI_Char *password,
  _In_       MI_Uint32 bufferLength,
  _Out_      MI_Uint32 *passwordLength,
  _Out_opt_  MI_Uint32 *flags
);

Parameters

options [in]

MI_DestinationOptions object returned from MI_Application_NewDestinationOptions.

index

Zero-based index of the credentials password.

optionName

A pointer to a null-terminated string containing the returned name of the option.

password

Returned password. This memory should be freed for security purposes when finished.

bufferLength [in]

Length of the password buffer. If 0, the passwordLength parameter will contain the buffer size needed to hold the password.

passwordLength [out]

Returned amount of the password buffer used, including the null terminator.

flags [out, optional]

Returned 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.

 

Remarks

Passwords should not be stored in memory for long periods of time in an unencrypted manner, as there are ways to snoop for them. After using the password, call the SecureZeroMemory function to clear out the password before deleting it.

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

 

 

Show:
© 2014 Microsoft