[C++]
The Add method creates a new FPCProtocolDefinition
object and returns a reference to it.
HRESULT Add(
BSTR ProtocolName,
BSTR ProtocolGuid,
long category,
IFPCProtocolDefinition** ppNew
);
Parameters
- ProtocolName
- [in] Required. BSTR that specifies the name of the new
protocol.
- ProtocolGuid
- [in, optional] BSTR that specifies the globally unique
identifier (GUID) of the new protocol. The default value is an
empty BSTR.
- category
- [in, optional] A 32-bit integer value that specifies the
category or categories to which the new protocol belongs. This
value is a bitwise combination of values from the FpcProtocolCategory enumerated
type. The default value is fpcProtocolCategoryUserDefined.
- ppNew
- [out] Address of an interface pointer that on return points to
the new IFPCProtocolDefinition interface created.
Return Values
This method can return one of the following:
- S_OK, indicating that the operation succeeded.
- An error code, indicating that the operation failed. In this
case, the [out] parameter returned is a null object.
[Visual Basic]
The Add method creates a new FPCProtocolDefinition
object and returns a reference to it.
Function Add( _
ByVal ProtocolName As String, _
[ ByVal ProtocolGuid As String ], _
[ ByVal category As Long ] _
) As FPCProtocolDefinition
Parameters
- ProtocolName
- [in] Required. String that specifies the name of the new
protocol.
- ProtocolGuid
- [in, optional] String that specifies the globally
unique identifier (GUID) of the new protocol. The default
value is an empty string.
- category
- [in, optional] A 32-bit integer value that specifies the
category or categories to which the new protocol belongs. This
value is a bitwise combination of values from the FpcProtocolCategory enumerated
type. The default value is fpcProtocolCategoryUserDefined.
Return Values
This method returns a reference to an FPCProtocolDefinition
object if successful. Otherwise, an error is raised that can be
intercepted by using an error handler.