_OrderGroup::GetAddress
.gif "Ee811607.c++_off(en-US,CS.10).gif")
.gif "Ee811607.vb_on(en-US,CS.10).gif")
Use this method to get the specified address Dictionary object.
Definition
HRESULT _OrderGroup::GetAddress(BSTRstrAddressId,IDictionary**ppRetVal);
Parameters
strAddressId
[in] A BSTR that specifies the address ID.
ppRetVal
[out, retval] The address of a pointer to receive an IDictionary interface, used to return the address dictionary. The return value will be set to NULL if the specified strAddressId is not found.
Return Values
This method returns an HRESULT indicating whether or not it completed successfully. See the Error Values section for more details.
If the specified address is found, this method returns a reference to that dictionary, otherwise it returns a Nothing object.
Error Values
This method returns S_OK (0x00000000) to indicate success and standard COM HRESULT error values to indicate failure. For more information about standard COM errors, see Standard COM Errors. Additional information may be available using the global Err object, which can be accessed using the API function GetErrorInfo. In particular, the GetDescription method of the IErrorInfo interface may return a text description of the error.
Remarks
The ppRetVal parameter contains valid data only if the method completed successfully.
For more information about memory ownership issues related to COM property and method parameters, see Managing COM Parameter Memory.