NWSMGetExtension

Returns the extension as specified by the extension tag.

Syntax

  #include <smsutapi.h> 
   
  CCODE NWSMGetExtension ( 
     void SM_HUGE                        *buffer,
     UINT32                              size, 
     UINT32                              extensionTag, 
     NWSM_EXTENSION_INFORMATION SM_HUGE    **extension,
     SMS_HANDLE                  *handle); 
  

Parameters

buffer

(IN) Points to the start of the extension buffer.

size

(IN) Size of the extension buffer.

extensionTag

(IN) Specifies the required extension information tag.

extension

(OUT) Points to the required extension information.

handle

(OUT) Points to the extension handle, used to maintain context information.

Return Values

The following table lists the return values associated with the function.

0x00000000

Successful

0xFFFBFFFD

NWSMUT_INVALID_PARAMETER

0xFFFBFFFB

NWSMUT_OUT_OF_MEMORY

0xFFFBFFF8

NWSMUT_NO_MORE_EXTENSIONS

Remarks

Extension information field info can contain pointer type fields and hence internal allocation are made to return such elements. NWSMCloseExtension should be called to free the resources that are allocated for such purpose.

On errors NWSMCloseExtension need not be called.

buffer should point to the start of the extension buffer. The size parameter should be set to the byte count of information present in the buffer parameter.

Application should copy the extension information as the pointer is reused by the call to get the next extension. To free the extension buffer call NWSMCloseExtension.

See Also

NWSMGetFirstExtension, NWSMCloseExtension