Skip to main content
MI_SubscriptionDeliveryOptions_GetCredentialsPasswordAt function

Gets a previously added credential password based on a specified index.

Syntax


 MI_INLINE MI_Result MI_SubscriptionDeliveryOptions_GetCredentialsPasswordAt(
  _In_       MI_SubscriptionDeliveryOptions *self,
  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

self [in]

A MI_SubscriptionDeliveryOptions structure.

index

Zero-based index of the credential password.

optionName

A pointer to a null-terminated string containing the returned name of the option. This name is owned by the MI_SubscriptionDeliveryOptions structure.

password

Returned password. This parameter is an in/out buffer that is passed in to be filled. This buffer should be cleared (using the SecureZeroMemory function) as soon as the password is no longer needed for security reasons. If the input value is NULL, the bufferLength parameter should be zero, and the length needed will be passed back in the passwordLength parameter.

bufferLength [in]

Length of the password buffer. If 0, the passwordLength value will receive the length of the buffer needed.

passwordLength [out]

Returned password length.

flags [out, optional]

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

See also

MI_SubscriptionDeliveryOptions