ifsrmcollection

package
v1.1.6 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Feb 18, 2025 License: MIT Imports: 12 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

View Source 
var (
	// IFsrmCollection interface identifier f76fbf3b-8ddd-4b42-b05a-cb1c3ff1fee8
	CollectionIID = &dcom.IID{Data1: 0xf76fbf3b, Data2: 0x8ddd, Data3: 0x4b42, Data4: []byte{0xb0, 0x5a, 0xcb, 0x1c, 0x3f, 0xf1, 0xfe, 0xe8}}
	// Syntax UUID
	CollectionSyntaxUUID = &uuid.UUID{TimeLow: 0xf76fbf3b, TimeMid: 0x8ddd, TimeHiAndVersion: 0x4b42, ClockSeqHiAndReserved: 0xb0, ClockSeqLow: 0x5a, Node: [6]uint8{0xcb, 0x1c, 0x3f, 0xf1, 0xfe, 0xe8}}
	// Syntax ID
	CollectionSyntaxV0_0 = &dcerpc.SyntaxID{IfUUID: CollectionSyntaxUUID, IfVersionMajor: 0, IfVersionMinor: 0}
)
View Source 
var (
	// import guard
	GoPackage = "dcom/fsrm"
)

Functions

func CollectionServerHandle 

func CollectionServerHandle(ctx context.Context, o CollectionServer, opNum int, r ndr.Reader) (dcerpc.Operation, error)

func NewCollectionServerHandle 

func NewCollectionServerHandle(o CollectionServer) dcerpc.ServerHandle

func RegisterCollectionServer 

func RegisterCollectionServer(conn dcerpc.Conn, o CollectionServer, opts ...dcerpc.Option)

Types

type CancelRequest 

type CancelRequest struct {
	// This: ORPCTHIS structure that is used to send ORPC extension data to the server.
	This *dcom.ORPCThis `idl:"name:This" json:"this"`
}

CancelRequest structure represents the Cancel operation request

func (*CancelRequest) MarshalNDR 

func (o *CancelRequest) MarshalNDR(ctx context.Context, w ndr.Writer) error

func (*CancelRequest) UnmarshalNDR 

func (o *CancelRequest) UnmarshalNDR(ctx context.Context, r ndr.Reader) error

type CancelResponse 

type CancelResponse struct {
	// That: ORPCTHAT structure that is used to return ORPC extension data to the client.
	That *dcom.ORPCThat `idl:"name:That" json:"that"`
	// Return: The Cancel return value.
	Return int32 `idl:"name:Return" json:"return"`
}

CancelResponse structure represents the Cancel operation response

func (*CancelResponse) MarshalNDR 

func (o *CancelResponse) MarshalNDR(ctx context.Context, w ndr.Writer) error

func (*CancelResponse) UnmarshalNDR 

func (o *CancelResponse) UnmarshalNDR(ctx context.Context, r ndr.Reader) error

type CollectionClient 

type CollectionClient interface {

	// IDispatch retrieval method.
	Dispatch() idispatch.DispatchClient

	// _NewEnum operation.
	Get_NewEnum(context.Context, *Get_NewEnumRequest, ...dcerpc.CallOption) (*Get_NewEnumResponse, error)

	// The Item method returns a pointer to the object at the requested position in the
	// collection of Objects Being Enumerated.
	//
	// Return Values: The method MUST return zero on success, or a nonzero error code on
	// failure.
	//
	//	+-------------------------------------+----------------------------------------------------------------------------------+
	//	|               RETURN                |                                                                                  |
	//	|             VALUE/CODE              |                                   DESCRIPTION                                    |
	//	|                                     |                                                                                  |
	//	+-------------------------------------+----------------------------------------------------------------------------------+
	//	+-------------------------------------+----------------------------------------------------------------------------------+
	//	| 0x80004003 E_POINTER                | The item parameter is NULL.                                                      |
	//	+-------------------------------------+----------------------------------------------------------------------------------+
	//	| 0x80131502 COR_E_ARGUMENTOUTOFRANGE | The value of the index parameter is greater than the number of Objects Being     |
	//	|                                     | Enumerated in the collection.                                                    |
	//	+-------------------------------------+----------------------------------------------------------------------------------+
	GetItem(context.Context, *GetItemRequest, ...dcerpc.CallOption) (*GetItemResponse, error)

	// The Count method returns the number of objects in the collection of Objects Being
	// Enumerated.
	//
	// Return Values: The method MUST return zero on success, or a nonzero error code on
	// failure.
	//
	//	+----------------------+------------------------------+
	//	|        RETURN        |                              |
	//	|      VALUE/CODE      |         DESCRIPTION          |
	//	|                      |                              |
	//	+----------------------+------------------------------+
	//	+----------------------+------------------------------+
	//	| 0x80004003 E_POINTER | The count parameter is NULL. |
	//	+----------------------+------------------------------+
	GetCount(context.Context, *GetCountRequest, ...dcerpc.CallOption) (*GetCountResponse, error)

	// The State method returns the state FsrmCollectionState_Complete.
	//
	// Return Values: The method MUST return zero on success, or a nonzero error code on
	// failure.
	//
	//	+----------------------+------------------------------+
	//	|        RETURN        |                              |
	//	|      VALUE/CODE      |         DESCRIPTION          |
	//	|                      |                              |
	//	+----------------------+------------------------------+
	//	+----------------------+------------------------------+
	//	| 0x80004003 E_POINTER | The state parameter is NULL. |
	//	+----------------------+------------------------------+
	GetState(context.Context, *GetStateRequest, ...dcerpc.CallOption) (*GetStateResponse, error)

	// Cancel operation.
	Cancel(context.Context, *CancelRequest, ...dcerpc.CallOption) (*CancelResponse, error)

	// WaitForCompletion operation.
	WaitForCompletion(context.Context, *WaitForCompletionRequest, ...dcerpc.CallOption) (*WaitForCompletionResponse, error)

	// The GetById method returns the object from the collection of Objects Being Enumerated
	// (section 3.2.1.11) whose ID matches the specified id.
	//
	// Return Values: The method MUST return zero on success, or a nonzero error code on
	// failure.
	//
	//	+-----------------------------+----------------------------------------------------------------------------------+
	//	|           RETURN            |                                                                                  |
	//	|         VALUE/CODE          |                                   DESCRIPTION                                    |
	//	|                             |                                                                                  |
	//	+-----------------------------+----------------------------------------------------------------------------------+
	//	+-----------------------------+----------------------------------------------------------------------------------+
	//	| 0x80045301 FSRM_E_NOT_FOUND | An object with the specified ID was not found in the collection.                 |
	//	+-----------------------------+----------------------------------------------------------------------------------+
	//	| 0x80070057 E_INVALIDARG     | This code is returned for the following reasons: The entry parameter is          |
	//	|                             | NULL. The objects in the collection of Objects Being Enumerated are not          |
	//	|                             | one of the following interfaces: IFsrmFileScreen, IFsrmFileScreenException,      |
	//	|                             | IFsrmFileScreenTemplate, IFsrmFileGroup, IFsrmQuota, IFsrmQuotaTemplate,         |
	//	|                             | IFsrmAction, IFsrmReportJob, IFsrmReport, IFsrmClassifcationRule,                |
	//	|                             | IFsrmPropertyDefinition, IFsrmPipelineModuleDefinition or                        |
	//	|                             | IFsrmFileManagementJob.                                                          |
	//	+-----------------------------+----------------------------------------------------------------------------------+
	GetByID(context.Context, *GetByIDRequest, ...dcerpc.CallOption) (*GetByIDResponse, error)

	// AlterContext alters the client context.
	AlterContext(context.Context, ...dcerpc.Option) error

	// Conn returns the client connection (unsafe)
	Conn() dcerpc.Conn

	// IPID sets the object interface identifier.
	IPID(context.Context, *dcom.IPID) CollectionClient
}

IFsrmCollection interface.

func NewCollectionClient 

func NewCollectionClient(ctx context.Context, cc dcerpc.Conn, opts ...dcerpc.Option) (CollectionClient, error)

type CollectionServer 

type CollectionServer interface {

	// IDispatch base class.
	idispatch.DispatchServer

	// _NewEnum operation.
	Get_NewEnum(context.Context, *Get_NewEnumRequest) (*Get_NewEnumResponse, error)

	// The Item method returns a pointer to the object at the requested position in the
	// collection of Objects Being Enumerated.
	//
	// Return Values: The method MUST return zero on success, or a nonzero error code on
	// failure.
	//
	//	+-------------------------------------+----------------------------------------------------------------------------------+
	//	|               RETURN                |                                                                                  |
	//	|             VALUE/CODE              |                                   DESCRIPTION                                    |
	//	|                                     |                                                                                  |
	//	+-------------------------------------+----------------------------------------------------------------------------------+
	//	+-------------------------------------+----------------------------------------------------------------------------------+
	//	| 0x80004003 E_POINTER                | The item parameter is NULL.                                                      |
	//	+-------------------------------------+----------------------------------------------------------------------------------+
	//	| 0x80131502 COR_E_ARGUMENTOUTOFRANGE | The value of the index parameter is greater than the number of Objects Being     |
	//	|                                     | Enumerated in the collection.                                                    |
	//	+-------------------------------------+----------------------------------------------------------------------------------+
	GetItem(context.Context, *GetItemRequest) (*GetItemResponse, error)

	// The Count method returns the number of objects in the collection of Objects Being
	// Enumerated.
	//
	// Return Values: The method MUST return zero on success, or a nonzero error code on
	// failure.
	//
	//	+----------------------+------------------------------+
	//	|        RETURN        |                              |
	//	|      VALUE/CODE      |         DESCRIPTION          |
	//	|                      |                              |
	//	+----------------------+------------------------------+
	//	+----------------------+------------------------------+
	//	| 0x80004003 E_POINTER | The count parameter is NULL. |
	//	+----------------------+------------------------------+
	GetCount(context.Context, *GetCountRequest) (*GetCountResponse, error)

	// The State method returns the state FsrmCollectionState_Complete.
	//
	// Return Values: The method MUST return zero on success, or a nonzero error code on
	// failure.
	//
	//	+----------------------+------------------------------+
	//	|        RETURN        |                              |
	//	|      VALUE/CODE      |         DESCRIPTION          |
	//	|                      |                              |
	//	+----------------------+------------------------------+
	//	+----------------------+------------------------------+
	//	| 0x80004003 E_POINTER | The state parameter is NULL. |
	//	+----------------------+------------------------------+
	GetState(context.Context, *GetStateRequest) (*GetStateResponse, error)

	// Cancel operation.
	Cancel(context.Context, *CancelRequest) (*CancelResponse, error)

	// WaitForCompletion operation.
	WaitForCompletion(context.Context, *WaitForCompletionRequest) (*WaitForCompletionResponse, error)

	// The GetById method returns the object from the collection of Objects Being Enumerated
	// (section 3.2.1.11) whose ID matches the specified id.
	//
	// Return Values: The method MUST return zero on success, or a nonzero error code on
	// failure.
	//
	//	+-----------------------------+----------------------------------------------------------------------------------+
	//	|           RETURN            |                                                                                  |
	//	|         VALUE/CODE          |                                   DESCRIPTION                                    |
	//	|                             |                                                                                  |
	//	+-----------------------------+----------------------------------------------------------------------------------+
	//	+-----------------------------+----------------------------------------------------------------------------------+
	//	| 0x80045301 FSRM_E_NOT_FOUND | An object with the specified ID was not found in the collection.                 |
	//	+-----------------------------+----------------------------------------------------------------------------------+
	//	| 0x80070057 E_INVALIDARG     | This code is returned for the following reasons: The entry parameter is          |
	//	|                             | NULL. The objects in the collection of Objects Being Enumerated are not          |
	//	|                             | one of the following interfaces: IFsrmFileScreen, IFsrmFileScreenException,      |
	//	|                             | IFsrmFileScreenTemplate, IFsrmFileGroup, IFsrmQuota, IFsrmQuotaTemplate,         |
	//	|                             | IFsrmAction, IFsrmReportJob, IFsrmReport, IFsrmClassifcationRule,                |
	//	|                             | IFsrmPropertyDefinition, IFsrmPipelineModuleDefinition or                        |
	//	|                             | IFsrmFileManagementJob.                                                          |
	//	+-----------------------------+----------------------------------------------------------------------------------+
	GetByID(context.Context, *GetByIDRequest) (*GetByIDResponse, error)
}

IFsrmCollection server interface.

type GetByIDRequest 

type GetByIDRequest struct {
	// This: ORPCTHIS structure that is used to send ORPC extension data to the server.
	This *dcom.ORPCThis `idl:"name:This" json:"this"`
	// id: The ID to use for identifying the object to be returned.
	ID *fsrm.ObjectID `idl:"name:id" json:"id"`
}

GetByIDRequest structure represents the GetById operation request

func (*GetByIDRequest) MarshalNDR 

func (o *GetByIDRequest) MarshalNDR(ctx context.Context, w ndr.Writer) error

func (*GetByIDRequest) UnmarshalNDR 

func (o *GetByIDRequest) UnmarshalNDR(ctx context.Context, r ndr.Reader) error

type GetByIDResponse 

type GetByIDResponse struct {
	// That: ORPCTHAT structure that is used to return ORPC extension data to the client.
	That *dcom.ORPCThat `idl:"name:That" json:"that"`
	// entry: Pointer to a VARIANT structure. Upon successful completion, it SHOULD contain
	// the IDispatch interface of the object from the collection of Objects Being Enumerated
	// whose ID matches the specified id.
	Entry *oaut.Variant `idl:"name:entry" json:"entry"`
	// Return: The GetById return value.
	Return int32 `idl:"name:Return" json:"return"`
}

GetByIDResponse structure represents the GetById operation response

func (*GetByIDResponse) MarshalNDR 

func (o *GetByIDResponse) MarshalNDR(ctx context.Context, w ndr.Writer) error

func (*GetByIDResponse) UnmarshalNDR 

func (o *GetByIDResponse) UnmarshalNDR(ctx context.Context, r ndr.Reader) error

type GetCountRequest 

type GetCountRequest struct {
	// This: ORPCTHIS structure that is used to send ORPC extension data to the server.
	This *dcom.ORPCThis `idl:"name:This" json:"this"`
}

GetCountRequest structure represents the Count operation request

func (*GetCountRequest) MarshalNDR 

func (o *GetCountRequest) MarshalNDR(ctx context.Context, w ndr.Writer) error

func (*GetCountRequest) UnmarshalNDR 

func (o *GetCountRequest) UnmarshalNDR(ctx context.Context, r ndr.Reader) error

type GetCountResponse 

type GetCountResponse struct {
	// That: ORPCTHAT structure that is used to return ORPC extension data to the client.
	That *dcom.ORPCThat `idl:"name:That" json:"that"`
	// count: Pointer to a variable that upon successful completion receives the number
	// of objects in the collection of Objects Being Enumerated.
	Count int32 `idl:"name:count" json:"count"`
	// Return: The Count return value.
	Return int32 `idl:"name:Return" json:"return"`
}

GetCountResponse structure represents the Count operation response

func (*GetCountResponse) MarshalNDR 

func (o *GetCountResponse) MarshalNDR(ctx context.Context, w ndr.Writer) error

func (*GetCountResponse) UnmarshalNDR 

func (o *GetCountResponse) UnmarshalNDR(ctx context.Context, r ndr.Reader) error

type GetItemRequest 

type GetItemRequest struct {
	// This: ORPCTHIS structure that is used to send ORPC extension data to the server.
	This *dcom.ORPCThis `idl:"name:This" json:"this"`
	// index: The position of the item in the collection of Objects Being Enumerated to
	// return.
	Index int32 `idl:"name:index" json:"index"`
}

GetItemRequest structure represents the Item operation request

func (*GetItemRequest) MarshalNDR 

func (o *GetItemRequest) MarshalNDR(ctx context.Context, w ndr.Writer) error

func (*GetItemRequest) UnmarshalNDR 

func (o *GetItemRequest) UnmarshalNDR(ctx context.Context, r ndr.Reader) error

type GetItemResponse 

type GetItemResponse struct {
	// That: ORPCTHAT structure that is used to return ORPC extension data to the client.
	That *dcom.ORPCThat `idl:"name:That" json:"that"`
	// item: Pointer to a VARIANT structure. Upon successful completion, receives the pointer
	// to the IDispatch interface for the object.
	Item *oaut.Variant `idl:"name:item" json:"item"`
	// Return: The Item return value.
	Return int32 `idl:"name:Return" json:"return"`
}

GetItemResponse structure represents the Item operation response

func (*GetItemResponse) MarshalNDR 

func (o *GetItemResponse) MarshalNDR(ctx context.Context, w ndr.Writer) error

func (*GetItemResponse) UnmarshalNDR 

func (o *GetItemResponse) UnmarshalNDR(ctx context.Context, r ndr.Reader) error

type GetStateRequest 

type GetStateRequest struct {
	// This: ORPCTHIS structure that is used to send ORPC extension data to the server.
	This *dcom.ORPCThis `idl:"name:This" json:"this"`
}

GetStateRequest structure represents the State operation request

func (*GetStateRequest) MarshalNDR 

func (o *GetStateRequest) MarshalNDR(ctx context.Context, w ndr.Writer) error

func (*GetStateRequest) UnmarshalNDR 

func (o *GetStateRequest) UnmarshalNDR(ctx context.Context, r ndr.Reader) error

type GetStateResponse 

type GetStateResponse struct {
	// That: ORPCTHAT structure that is used to return ORPC extension data to the client.
	That *dcom.ORPCThat `idl:"name:That" json:"that"`
	// state: Pointer to a variable that upon completion contains the state FsrmCollectionState_Complete.
	State fsrm.CollectionState `idl:"name:state" json:"state"`
	// Return: The State return value.
	Return int32 `idl:"name:Return" json:"return"`
}

GetStateResponse structure represents the State operation response

func (*GetStateResponse) MarshalNDR 

func (o *GetStateResponse) MarshalNDR(ctx context.Context, w ndr.Writer) error

func (*GetStateResponse) UnmarshalNDR 

func (o *GetStateResponse) UnmarshalNDR(ctx context.Context, r ndr.Reader) error

type Get_NewEnumRequest 

type Get_NewEnumRequest struct {
	// This: ORPCTHIS structure that is used to send ORPC extension data to the server.
	This *dcom.ORPCThis `idl:"name:This" json:"this"`
}

Get_NewEnumRequest structure represents the _NewEnum operation request

func (*Get_NewEnumRequest) MarshalNDR 

func (o *Get_NewEnumRequest) MarshalNDR(ctx context.Context, w ndr.Writer) error

func (*Get_NewEnumRequest) UnmarshalNDR 

func (o *Get_NewEnumRequest) UnmarshalNDR(ctx context.Context, r ndr.Reader) error

type Get_NewEnumResponse 

type Get_NewEnumResponse struct {
	// That: ORPCTHAT structure that is used to return ORPC extension data to the client.
	That    *dcom.ORPCThat `idl:"name:That" json:"that"`
	Unknown *dcom.Unknown  `idl:"name:unknown" json:"unknown"`
	// Return: The _NewEnum return value.
	Return int32 `idl:"name:Return" json:"return"`
}

Get_NewEnumResponse structure represents the _NewEnum operation response

func (*Get_NewEnumResponse) MarshalNDR 

func (o *Get_NewEnumResponse) MarshalNDR(ctx context.Context, w ndr.Writer) error

func (*Get_NewEnumResponse) UnmarshalNDR 

func (o *Get_NewEnumResponse) UnmarshalNDR(ctx context.Context, r ndr.Reader) error

type UnimplementedCollectionServer added in v1.1.5 

type UnimplementedCollectionServer struct {
	idispatch.UnimplementedDispatchServer
}

Unimplemented IFsrmCollection

func (UnimplementedCollectionServer) Cancel added in v1.1.5 

func (UnimplementedCollectionServer) Cancel(context.Context, *CancelRequest) (*CancelResponse, error)

func (UnimplementedCollectionServer) GetByID added in v1.1.5 

func (UnimplementedCollectionServer) GetByID(context.Context, *GetByIDRequest) (*GetByIDResponse, error)

func (UnimplementedCollectionServer) GetCount added in v1.1.5 

func (UnimplementedCollectionServer) GetCount(context.Context, *GetCountRequest) (*GetCountResponse, error)

func (UnimplementedCollectionServer) GetItem added in v1.1.5 

func (UnimplementedCollectionServer) GetItem(context.Context, *GetItemRequest) (*GetItemResponse, error)

func (UnimplementedCollectionServer) GetState added in v1.1.5 

func (UnimplementedCollectionServer) GetState(context.Context, *GetStateRequest) (*GetStateResponse, error)

func (UnimplementedCollectionServer) Get_NewEnum added in v1.1.5 

func (UnimplementedCollectionServer) Get_NewEnum(context.Context, *Get_NewEnumRequest) (*Get_NewEnumResponse, error)

func (UnimplementedCollectionServer) WaitForCompletion added in v1.1.5 

func (UnimplementedCollectionServer) WaitForCompletion(context.Context, *WaitForCompletionRequest) (*WaitForCompletionResponse, error)

type WaitForCompletionRequest 

type WaitForCompletionRequest struct {
	// This: ORPCTHIS structure that is used to send ORPC extension data to the server.
	This        *dcom.ORPCThis `idl:"name:This" json:"this"`
	WaitSeconds int32          `idl:"name:waitSeconds" json:"wait_seconds"`
}

WaitForCompletionRequest structure represents the WaitForCompletion operation request

func (*WaitForCompletionRequest) MarshalNDR 

func (o *WaitForCompletionRequest) MarshalNDR(ctx context.Context, w ndr.Writer) error

func (*WaitForCompletionRequest) UnmarshalNDR 

func (o *WaitForCompletionRequest) UnmarshalNDR(ctx context.Context, r ndr.Reader) error

type WaitForCompletionResponse 

type WaitForCompletionResponse struct {
	// That: ORPCTHAT structure that is used to return ORPC extension data to the client.
	That      *dcom.ORPCThat `idl:"name:That" json:"that"`
	Completed int16          `idl:"name:completed" json:"completed"`
	// Return: The WaitForCompletion return value.
	Return int32 `idl:"name:Return" json:"return"`
}

WaitForCompletionResponse structure represents the WaitForCompletion operation response

func (*WaitForCompletionResponse) MarshalNDR 

func (o *WaitForCompletionResponse) MarshalNDR(ctx context.Context, w ndr.Writer) error

func (*WaitForCompletionResponse) UnmarshalNDR 

func (o *WaitForCompletionResponse) UnmarshalNDR(ctx context.Context, r ndr.Reader) error

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.