IWMSContext::GetArrayValue

The GetArrayValue method retrieves a pointer to a SAFEARRAY of BSTR values.

Syntax

  HRESULT GetArrayValue(
  LPCWSTR  pstrName,
  long  lNameHint,
  SAFEARRAY(BSTR)*  ppsaValue,
  long  dwOptions
);

Parameters

pstrName

[in] LPCWSTR specifying the name portion of the name-value pair in the context.

lNameHint

[in] long containing an optional key that can be used to more efficiently access a value.

ppsaValue

[out] Pointer to a pointer to a SAFEARRAY of BSTR values.

dwOptions

[in] Reserved for future use.

Return Values

If the method succeeds, it returns S_OK. If it fails, it returns an HRESULT error code.

Return code	Number	Description
DISP_E_BADINDEX	0x8002000B	The property specified by the pstrName parameter could not be found.
DISP_E_TYPEMISMATCH	0x80020005	The data type of the property specified by the pstrName parameter is not VT_ARRAY.
E_POINTER	0x80004003	The ppsaValue parameter is NULL.

Remarks

The current release has no public contexts that contain a SAFEARRAY value.

Requirements

Header: wmscontext.h.

Library: WMSServerTypeLib.dll.

Platform: Windows Server 2003, Enterprise Edition; Windows Server 2003, Datacenter Edition; Windows Server 2008.

See Also

Previous

Additional resources