Protocol Object

The Protocol object represents the information about a protocol for a user's application. The information is published by a user who is registered on the ILS server.

IIlsProtocol Interface
IConnectionPoint—IIlsProtocolNotify Interface

Back to ILS Reference

IIlsProtocol Interface

The IIlsProtocol interface is obtained from the IIlsUser::GetProtocol method. This section describes the IIlsProtocol interface methods.

GetAllExtendedAttributes
GetExtendedAttribute
GetPortNumber
GetStandardAttribute
IsWritable
RemoveExtendedAttribute
SetExtendedAttribute
SetStandardAttribute
Update

Back to User Object

IIlsProtocol::GetAllExtendedAttributes

HRESULT IIlsProtocol::GetAllExtendedAttributes(
    IIlsAttributes  **ppAttributes);

Returns all extended attributes, in the form of an Attributes object, from the Protocol object. This is an alternative to getting each extended attribute individually through IIlsProtocol::GetExtendedAttribute.

This method is not yet implemented.

Currently returns ILS_E_NOT_IMPL.

ppAttributes: Buffer to receive the address of the Attributes object.

Back to IIlsProtocol Interface

Back to Protocol Object

Back to ILS Object Listing

IIlsProtocol::GetExtendedAttribute

HRESULT IIlsProtocol::GetExtendedAttribute(
    BSTR  bstrName,
    BSTR  *pbstrValue);

Returns a named extended attribute belonging to the Protocol object.

This method is not yet implemented.

Currently returns ILS_E_NOT_IMPL.

bstrName: Name of the extended attribute.
pbstrValue: Address of the buffer to store the value retrieved.

Back to IIlsProtocol Interface

Back to Protocol Object

Back to ILS Object Listing

IIlsProtocol::GetPortNumber

HRESULT GetPortNumber
    [out] ULONG *pulPortNumber);

Returns the port number used by this protocol.

Returns S_OK if successful, or ILS_E_POINTER if the address of the return buffer is NULL.

pulPortNumber: Address of the buffer where the port number is returned.

Back to IIlsProtocol Interface

Back to Protocol Object

Back to ILS Object Listing

IIlsProtocol::GetStandardAttribute

HRESULT IIlsProtocol::GetStandardAttribute(
    ILS_STD_ATTR_NAME  StdAttr,
    BSTR  *pbstrValue);

Returns a standard attribute belonging to the Protocol object.

Returns one of the following values:

S_OK Success.
ILS_E_POINTER Address of the return buffer is NULL.
ILS_E_PARAMETER Incorrect attribute for this object.
ILS_E_MEMORY Unable to allocate enough memory for this request.

StdAttr

Standard attribute of the Protocol object. Can be one of the following:

ILS_STDATTR_PROTOCOL_NAME = 13

ILS_STDATTR_MIME_TYPE = 14

ILS_STDATTR_PORT =15

pbstrValue

Pointer to receive a null-terminated string for the protocol's standard attribute.

Back to IIlsProtocol Interface

Back to Protocol Object

Back to ILS Object Listing

IIlsProtocol::IsWritable

HRESULT IIlsProtocol::IsWritable(
    BOOL  *pValue);

Returns whether the Protocol object can be written to.

Returns S_OK if successful, or ILS_E_POINTER if the address of the return buffer is NULL.

pValue: Address of the buffer to receive the Boolean variable.

Protocol objects returned from enumeration or IIlsUser::GetProtocol cannot be written to, but those created through IIlsUser::CreateProtocol can.

Back to IIlsProtocol Interface

Back to Protocol Object

Back to ILS Object Listing

IIlsProtocol::RemoveExtendedAttribute

HRESULT IIlsProtocol::RemoveExtendedAttribute(
    BSTR  bstrName);

Removes an extended attribute. The modification will not be reflected on the ILS server until the IIlsProtocol::Update method is called.

This method is not yet implemented.

Currently returns ILS_E_NOT_IMPL.

bstrName: Extended attribute to be removed.

Back to IIlsProtocol Interface

Back to Protocol Object

Back to ILS Object Listing

IIlsProtocol::SetExtendedAttribute

HRESULT IIlsProtocol::SetExtendedAttribute(
    BSTR  bstrName,
    BSTR  bstrValue);

Allows the application to modify an extended attribute of the protocol. The modification will not be reflected on the ILS server until the IIlsProtocol::Update method is called.

This method is not yet implemented.

Currently returns ILS_E_NOT_IMPL.

bstrName: Name of the extended attribute.
bstrValue: Value to be set.

Back to IIlsProtocol Interface

Back to Protocol Object

Back to ILS Object Listing

IIlsProtocol::SetStandardAttribute

HRESULT IIlsProtocol::SetStandardAttribute(
    ILS_STD_ATTR_NAME  StdAttr,
    BSTR  bstrValue);

Allows the application to modify a standard attribute of the protocol. The modification will not be reflected on the ILS server until the IIlsProtocol::Update method is called.

This method is not yet implemented.

Returns ILS_E_FAIL if unsuccessful.

StdAttr

Standard attribute of the Protocol object. Can be one of the following:

ILS_STDATTR_PROTOCOL_NAME = 13

ILS_STDATTR_MIME_TYPE = 14

ILS_STDATTR_PORT = 15

bstrValue

Null-terminated string for the protocol's standard attribute.

Back to IIlsProtocol Interface

Back to Protocol Object

Back to ILS Object Listing

IIlsProtocol::Update

HRESULT IIlsProtocol::Update(
    ULONG  *puReqID);

Reflects updated protocol information to the ILS server.

This method is not yet implemented.

Returns ILS_E_FAIL if unsuccessful.

puReqID: Address of a ULONG buffer to receive the request identifier.

This method is an asynchronous operation. The application receives the IIlsProtocolNotify::UpdateResult notification for the registration result.

Back to IIlsProtocol Interface

Back to Protocol Object

Back to ILS Object Listing

IConnectionPointContainer

The IConnectionPointContainer_IIlsProtocol interface is instantiated from IID_IConnectionPointContainer to identify Protocol as a connectable object. The interface contains the standard set of methods for IConnectionPointContainer_IIlsProtocol.

IConnectionPoint

The IConnectionPoint_IIlsProtocol interface is instantiated from IConnectionPointContainer_IIlsProtocol. The Protocol object provides only one connection point—IID_IIlsProtocolNotify—for a client's sink object to receive the callback notification. The client must provide the IIlsProtocolNotify interface methods described in this section in the sink object.

IIlsProtocolNotify Interface

This interface is implemented by a client application that will receive notifications from a Protocol object.

UpdateResult

Back to Protocol Object

IIlsProtocolNotify::UpdateResult

HRESULT IIlsProtocolNotify::UpdateResult(
    ULONG  uReqID,
    HRESULT  hResult);

Notifies the Protocol object when an update request is made. If the request is successful, the updated information is propagated to the ILS server.

Returns S_OK if successful, or an error code otherwise.

uReqID: Request identifier matching the IIlsProtocol::Update method.
hResult: Modification result. Returns S_OK if the information is changed, or an error code otherwise.

Back to IIlsProtocolNotify Interface

Back to Protocol Object

Back to ILS Object Listing

S_OK	Success.
ILS_E_POINTER	Address of the return buffer is NULL.
ILS_E_PARAMETER	Incorrect attribute for this object.
ILS_E_MEMORY	Unable to allocate enough memory for this request.