IDssp Interface

WS-Transfer provides generic accessor methods for various classes.

XML namespace dssp=http://schemas.microsoft.com/xw/2004/10/dssp.html

C type for interface pointer:

Methods: Timestamp NotificationHeader CreateRequest DeleteRequest DropRequest GetRequest InsertRequest LookupRequest NotifyRequest QueryRequest ReplaceRequest SubscribeRequest UpdateRequest UpsertRequest

Structs: Subscription RecordList DefaultInsertResponse DefaultReplaceResponse DefaultDeleteResponse DefaultUpdateResponse DefaultUpsertResponse Partner Alias ServiceInfoType

Methods

Timestamp: HEADER: Time at sender when message was sent. (absolute wall time).
NotificationHeader: HEADER: goes along with dssp:NotifyRequest.
CreateRequest: Create new object.
DeleteRequest: Delete some state value.
DropRequest: Zap object.
GetRequest: XXX This function runs but is in progress still.
InsertRequest: Insert new values.
LookupRequest: Get all existing partners.
NotifyRequest: Delete all existing states and insert new states.
QueryRequest: Get some existing states.
ReplaceRequest: Delete all existing states and insert new states.
SubscribeRequest: Subscribe to some existing states.
UpdateRequest: Retrieve values.
UpsertRequest: Update or insert values.

IDssp.Timestamp Method

HEADER: Time at sender when message was sent. (absolute wall time).

SCODE Timestamp( 
    /*in,this*/ PIDSSP iThis,
    /*in*/ PICONTINUATION cont,
    /*in*/ TIME Value)

cont

State of current message processing.

This represents the activation to execute with the given reservation.

Value

The time at the sender at the time of message construction.

C++

SCODE IDssp::Timestamp( 
    /*in*/ PICONTINUATION cont,
    /*in*/ TIME Value)

IDssp.NotificationHeader Method

HEADER: goes along with dssp:NotifyRequest.

SCODE NotificationHeader( 
    /*in,this*/ PIDSSP iThis,
    /*in*/ PICONTINUATION cont,
    /*in*/ const _TCHAR * ForwardedAction)

cont

State of current message processing.

This represents the activation to execute with the given reservation.

ForwardedAction

The action that we are notifying about, i.e. the Action of Update,Replace,Upsert,Insert. e,g, http://schemas.microsoft.com/xw/2004/10/dssp.html:ReplaceRequest

C++

SCODE IDssp::NotificationHeader( 
    /*in*/ PICONTINUATION cont,
    /*in*/ const _TCHAR * ForwardedAction)

IDssp.CreateRequest Method

Create new object.

SCODE CreateRequest( 
    /*in,this*/ PIDSSP iThis,
    /*in*/ const _TCHAR * To,
    /*in,type-is*/ const void * InitialValue,
    /*in,type-of*/ const _TCHAR * ValueType,
    /*out,optional,size-is,type-is*/ void * Value,
    /*out,type-of*/ _TCHAR * pValueType,
    /*in,size-of*/ UINT ValueSize)

Returns S_OK if the method is successful, otherwise an error code.

To: The URI for the resource we are getting. Transferred in the wsman:ResourceURI header.
InitialValue: Initial partner list.
ValueType: Type of InitialValue.
Value: Return current value here.
pValueType: Type of NewValue is returned here (this may be unnecessary).
ValueSize: Size of buffer (Value).

C++

SCODE IDssp::CreateRequest( 
    /*in*/ const _TCHAR * To,
    /*in,type-is*/ const void * InitialValue,
    /*in,type-of*/ const _TCHAR * ValueType,
    /*out,optional,size-is,type-is*/ void * Value,
    /*out,type-of*/ _TCHAR * pValueType,
    /*in,size-of*/ UINT ValueSize)

IDssp.DeleteRequest Method

Delete some state value.

SCODE DeleteRequest( 
    /*in,this*/ PIDSSP iThis,
    /*in*/ const _TCHAR * To,
    /*in,type-is*/ const void * NewValue,
    /*in,type-of*/ const _TCHAR * NewValueType,
    /*out,optional,size-is,type-is*/ void * Value,
    /*out,type-of*/ _TCHAR * pValueType,
    /*in,size-of*/ UINT ValueSize)

Returns S_OK if the method is successful, otherwise an error code.

To: The URI for request. Transferred in the wsa:To header.
NewValue: Dynamically typed new value.
NewValueType: Type of NewValue.
Value: Return value that was deleted.
pValueType: Type of deleted value is returned here.
ValueSize: Size of buffer (Value).

C++

SCODE IDssp::DeleteRequest( 
    /*in*/ const _TCHAR * To,
    /*in,type-is*/ const void * NewValue,
    /*in,type-of*/ const _TCHAR * NewValueType,
    /*out,optional,size-is,type-is*/ void * Value,
    /*out,type-of*/ _TCHAR * pValueType,
    /*in,size-of*/ UINT ValueSize)

IDssp.DropRequest Method

Zap object.

SCODE DropRequest( 
    /*in,this*/ PIDSSP iThis,
    /*in*/ const _TCHAR * To,
    /*in*/ BOOL DropRequest,
    /*out,optional,size-is,type-is*/ void * Value,
    /*out,type-of*/ _TCHAR * pValueType,
    /*in,size-of*/ UINT ValueSize)

Returns S_OK if the method is successful, otherwise an error code.

To: The URI for the resource we are deleting. Transferred in the wsman:ResourceURI header.
DropRequest: Add empty wrapper element for request only. Should always be TRUE.
Value: Return current value here.
pValueType: Type of NewValue is returned here (this may be unnecessary).
ValueSize: Size of buffer (Value).

C++

SCODE IDssp::DropRequest( 
    /*in*/ const _TCHAR * To,
    /*in*/ BOOL DropRequest,
    /*out,optional,size-is,type-is*/ void * Value,
    /*out,type-of*/ _TCHAR * pValueType,
    /*in,size-of*/ UINT ValueSize)

IDssp.GetRequest Method

XXX This function runs but is in progress still.

SCODE GetRequest( 
    /*in,this*/ PIDSSP iThis,
    /*in*/ const _TCHAR * To,
    /*in*/ BOOL GetRequest,
    /*out,size-is*/ void * Buffer,
    /*in,size-of*/ UINT BufferSize,
    /*out,optional*/ PRecordList * RecordList)

Returns S_OK if the method is successful, otherwise an error code.

To: The URI for request. Transferred in the wsa:To header.
GetRequest: Add empty wrapper element for request only. Should always be TRUE.
Buffer: Buffer for placing received items. Not a real RPC parameter.
BufferSize
RecordList

C++

SCODE IDssp::GetRequest( 
    /*in*/ const _TCHAR * To,
    /*in*/ BOOL GetRequest,
    /*out,size-is*/ void * Buffer,
    /*in,size-of*/ UINT BufferSize,
    /*out,optional*/ PRecordList * RecordList)

IDssp.InsertRequest Method

Insert new values.

SCODE InsertRequest( 
    /*in,this*/ PIDSSP iThis,
    /*in*/ const _TCHAR * To,
    /*in,type-is*/ const void * NewValue,
    /*in,type-of*/ const _TCHAR * NewValueType,
    /*out,optional,size-is,type-is*/ void * Value,
    /*out,type-of*/ _TCHAR * pValueType,
    /*in,size-of*/ UINT ValueSize)

Returns S_OK if the method is successful, otherwise an error code.

To: The URI for request. Transferred in the wsa:To header.
NewValue: Dynamically typed new value.
NewValueType: Type of NewValue.
Value: Return current value here.
pValueType: Type of NewValue is returned here.
ValueSize: Size of buffer (Value).

C++

SCODE IDssp::InsertRequest( 
    /*in*/ const _TCHAR * To,
    /*in,type-is*/ const void * NewValue,
    /*in,type-of*/ const _TCHAR * NewValueType,
    /*out,optional,size-is,type-is*/ void * Value,
    /*out,type-of*/ _TCHAR * pValueType,
    /*in,size-of*/ UINT ValueSize)

IDssp.LookupRequest Method

Get all existing partners.

SCODE LookupRequest( 
    /*in,this*/ PIDSSP iThis,
    /*in*/ const _TCHAR * To,
    /*in*/ BOOL LookupRequest,
    /*out,size-is*/ void * Buffer,
    /*in,size-of*/ UINT BufferSize,
    /*out,optional*/ PRecordList * RecordList)

Returns S_OK if the method is successful, otherwise an error code.

To: The URI for request. Transferred in the wsa:To header.
LookupRequest: Add empty wrapper element for request only. Should always be TRUE.
Buffer: Buffer for placing received items. Not a real RPC parameter.
BufferSize
RecordList

C++

SCODE IDssp::LookupRequest( 
    /*in*/ const _TCHAR * To,
    /*in*/ BOOL LookupRequest,
    /*out,size-is*/ void * Buffer,
    /*in,size-of*/ UINT BufferSize,
    /*out,optional*/ PRecordList * RecordList)

IDssp.NotifyRequest Method

Delete all existing states and insert new states.

SCODE NotifyRequest( 
    /*in,this*/ PIDSSP iThis,
    /*in*/ const _TCHAR * To,
    /*in*/ const _TCHAR * ForwardedAction,
    /*in,type-is*/ const void * NewValue,
    /*in,type-of*/ const _TCHAR * NewValueType)

To: The URI for request. Transferred in the wsa:To header.
ForwardedAction: The Action of the operation that was forwarded. Transferred in the dssp:NotificationHeader header.
NewValue: Dynamically typed new value.
NewValueType: Type of NewValue.

C++

SCODE IDssp::NotifyRequest( 
    /*in*/ const _TCHAR * To,
    /*in*/ const _TCHAR * ForwardedAction,
    /*in,type-is*/ const void * NewValue,
    /*in,type-of*/ const _TCHAR * NewValueType)

IDssp.QueryRequest Method

Get some existing states.

SCODE QueryRequest( 
    /*in,this*/ PIDSSP iThis,
    /*in*/ const _TCHAR * To,
    /*in,type-is,selector-is*/ const void * QueryValue,
    /*in,type-of*/ const _TCHAR * QueryValueType,
    /*in,selector-of*/ const UINT32* QueryValueSelector,
    /*out,size-is*/ void * Buffer,
    /*in,size-of*/ UINT BufferSize,
    /*out,optional*/ PRecordList * RecordList)

Returns S_OK if the method is successful, otherwise an error code.

To: The URI for request. Transferred in the wsa:To header.
QueryValue: Dynamically typed reference element that is used to compare to candidate elements.
QueryValueType: Type of QueryValue.
QueryValueSelector: Active fields of QueryValue. Only the fields that are actually present are used for comparison.
Buffer: Buffer for placing received items. Not a real RPC parameter.
BufferSize
RecordList

C++

SCODE IDssp::QueryRequest( 
    /*in*/ const _TCHAR * To,
    /*in,type-is,selector-is*/ const void * QueryValue,
    /*in,type-of*/ const _TCHAR * QueryValueType,
    /*in,selector-of*/ const UINT32* QueryValueSelector,
    /*out,size-is*/ void * Buffer,
    /*in,size-of*/ UINT BufferSize,
    /*out,optional*/ PRecordList * RecordList)

IDssp.ReplaceRequest Method

Delete all existing states and insert new states.

SCODE ReplaceRequest( 
    /*in,this*/ PIDSSP iThis,
    /*in*/ const _TCHAR * To,
    /*in,type-is*/ const void * NewValue,
    /*in,type-of*/ const _TCHAR * NewValueType,
    /*out,optional,size-is,type-is*/ void * Value,
    /*out,type-of*/ _TCHAR * pValueType,
    /*in,size-of*/ UINT ValueSize)

Returns S_OK if the method is successful, otherwise an error code.

To: The URI for request. Transferred in the wsa:To header.
NewValue: Dynamically typed new value.
NewValueType: Type of NewValue.
Value: Return current value here.
pValueType: Type of NewValue is returned here.
ValueSize: Size of buffer (Value).

C++

SCODE IDssp::ReplaceRequest( 
    /*in*/ const _TCHAR * To,
    /*in,type-is*/ const void * NewValue,
    /*in,type-of*/ const _TCHAR * NewValueType,
    /*out,optional,size-is,type-is*/ void * Value,
    /*out,type-of*/ _TCHAR * pValueType,
    /*in,size-of*/ UINT ValueSize)

IDssp.SubscribeRequest Method

Subscribe to some existing states.

SCODE SubscribeRequest( 
    /*in,this*/ PIDSSP iThis,
    /*in*/ const _TCHAR * To,
    /*in*/ TIME Expiration,
    /*in*/ UINT NotificationCount,
    /*out,size-is*/ _TCHAR * SubscriptionManager,
    /*in,size-of*/ UINT ManagerSize,
    /*inout,size-is*/ _TCHAR * Subscriber,
    /*in,size-of*/ UINT SubscriberSize)

Returns S_OK if the method is successful, otherwise an error code.

To
Expiration
NotificationCount
SubscriptionManager
ManagerSize: The size of the buffer.
Subscriber: .
SubscriberSize: The size of the buffer.

C++

SCODE IDssp::SubscribeRequest( 
    /*in*/ const _TCHAR * To,
    /*in*/ TIME Expiration,
    /*in*/ UINT NotificationCount,
    /*out,size-is*/ _TCHAR * SubscriptionManager,
    /*in,size-of*/ UINT ManagerSize,
    /*inout,size-is*/ _TCHAR * Subscriber,
    /*in,size-of*/ UINT SubscriberSize)

IDssp.UpdateRequest Method

Retrieve values.

SCODE UpdateRequest( 
    /*in,this*/ PIDSSP iThis,
    /*in*/ const _TCHAR * To,
    /*in,type-is*/ const void * NewValue,
    /*in,type-of*/ const _TCHAR * NewValueType,
    /*out,optional,size-is,type-is*/ void * Value,
    /*out,type-of*/ _TCHAR * pValueType,
    /*in,size-of*/ UINT ValueSize)

Returns S_OK if the method is successful, otherwise an error code.

To: The URI for request. Transferred in the wsa:To header.
NewValue: Dynamically typed new value.
NewValueType: Type of NewValue.
Value: Return current value here.
pValueType: Type of NewValue is returned here.
ValueSize: Size of buffer (Value).

C++

SCODE IDssp::UpdateRequest( 
    /*in*/ const _TCHAR * To,
    /*in,type-is*/ const void * NewValue,
    /*in,type-of*/ const _TCHAR * NewValueType,
    /*out,optional,size-is,type-is*/ void * Value,
    /*out,type-of*/ _TCHAR * pValueType,
    /*in,size-of*/ UINT ValueSize)

IDssp.UpsertRequest Method

Update or insert values.

SCODE UpsertRequest( 
    /*in,this*/ PIDSSP iThis,
    /*in*/ const _TCHAR * To,
    /*in,type-is*/ const void * NewValue,
    /*in,type-of*/ const _TCHAR * NewValueType,
    /*out,optional,size-is,type-is*/ void * Value,
    /*out,type-of*/ _TCHAR * pValueType,
    /*in,size-of*/ UINT ValueSize)

Returns S_OK if the method is successful, otherwise an error code.

To: The URI for request. Transferred in the wsa:To header.
NewValue: Dynamically typed new value.
NewValueType: Type of NewValue.
Value: Return current value here.
pValueType: Type of NewValue is returned here.
ValueSize: Size of buffer (Value).

C++

SCODE IDssp::UpsertRequest( 
    /*in*/ const _TCHAR * To,
    /*in,type-is*/ const void * NewValue,
    /*in,type-of*/ const _TCHAR * NewValueType,
    /*out,optional,size-is,type-is*/ void * Value,
    /*out,type-of*/ _TCHAR * pValueType,
    /*in,size-of*/ UINT ValueSize)

Subscription Structure

Fields

Subscriber: C/C++ type: _TCHAR *; Serializer Type: string
Expiration: C/C++ type: TIME; Serializer Type: TIME
NotificationCount: C/C++ type: UINT; Serializer Type: UINT

RecordList Structure

Fields

Value: C/C++ type: void *; Serializer Type: ANYTYPE
ValueType: C/C++ type: _TCHAR *
ListNode: C/C++ type: LISTNODE

DefaultInsertResponse Structure

Fields

ListNode: C/C++ type: LISTNODE

DefaultReplaceResponse Structure

Fields

ListNode: C/C++ type: LISTNODE

DefaultDeleteResponse Structure

Fields

ListNode: C/C++ type: LISTNODE

DefaultUpdateResponse Structure

Fields

ListNode: C/C++ type: LISTNODE

DefaultUpsertResponse Structure

Fields

ListNode: C/C++ type: LISTNODE

Partner Structure

Fields

Name: C/C++ type: _TCHAR *; Serializer Type: QNAME; The role of the partner.
ServiceDirectory: C/C++ type: _TCHAR *; Serializer Type: string; The URL of the partner.
ListNode_Partner: C/C++ type: LISTNODE

Alias Structure

Fields

Value: C/C++ type: _TCHAR *; Serializer Type: string
ListNode_Alias: C/C++ type: LISTNODE

ServiceInfoType Structure

Fields

Contract: C/C++ type: _TCHAR *; Serializer Type: string
Name: C/C++ type: _TCHAR *; Serializer Type: string
AliasList: C/C++ type: PAlias; Serializer Type: PAlias
PartnerList: C/C++ type: PPartner; Serializer Type: PPartner